mirror of
https://github.com/boostorg/json.git
synced 2025-05-11 05:33:57 +00:00
165 lines
8.2 KiB
Plaintext
165 lines
8.2 KiB
Plaintext
[/
|
|
Copyright (c) 2019 Vinnie Falco (vinnie.falco@gmail.com)
|
|
|
|
Distributed under the Boost Software License, Version 1.0. (See accompanying
|
|
file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
|
|
|
|
Official repository: https://github.com/cppalliance/json
|
|
]
|
|
|
|
[library Boost.JSON
|
|
[id json]
|
|
[quickbook 1.6]
|
|
[copyright 2019 - 2020 Vinnie Falco]
|
|
[copyright 2020 Krystian Stasiowski]
|
|
[purpose JSON Library]
|
|
[license
|
|
Distributed under the Boost Software License, Version 1.0.
|
|
(See accompanying file LICENSE_1_0.txt or copy at
|
|
[@http://www.boost.org/LICENSE_1_0.txt])
|
|
]
|
|
[authors [Falco, Vinnie], [Stasiowski, Krystian]]
|
|
[category template]
|
|
[category generic]
|
|
]
|
|
|
|
[template mdash[] '''— ''']
|
|
[template indexterm1[term1] '''<indexterm><primary>'''[term1]'''</primary></indexterm>''']
|
|
[template indexterm2[term1 term2] '''<indexterm><primary>'''[term1]'''</primary><secondary>'''[term2]'''</secondary></indexterm>''']
|
|
|
|
[template include_file[path][^<'''<ulink url="https://github.com/cppalliance/json/blob/master/include/'''[path]'''">'''[path]'''</ulink>'''>]]
|
|
[template issue[n] '''<ulink url="https://github.com/cppalliance/json/issues/'''[n]'''">#'''[n]'''</ulink>''']
|
|
|
|
[/ Named Requirements ]
|
|
|
|
[def __Handler__ ['Handler]]
|
|
|
|
[def __Allocator__ [@https://en.cppreference.com/w/cpp/named_req/Allocator ['Allocator]]]
|
|
[def __CopyAssignable__ [@https://en.cppreference.com/w/cpp/named_req/CopyAssignable ['CopyAssignable]]]
|
|
[def __CopyConstructible__ [@https://en.cppreference.com/w/cpp/named_req/CopyConstructible ['CopyConstructible]]]
|
|
[def __Copyable__ [@https://en.cppreference.com/w/cpp/concepts/copyable ['Copyable]]]
|
|
[def __DefaultConstructible__ [@https://en.cppreference.com/w/cpp/named_req/DefaultConstructible ['DefaultConstructible]]]
|
|
[def __Hash__ [@https://en.cppreference.com/w/cpp/named_req/Hash ['Hash]]]
|
|
[def __InputIterator__ [@https://en.cppreference.com/w/cpp/named_req/InputIterator ['InputIterator]]]
|
|
[def __MoveAssignable__ [@https://en.cppreference.com/w/cpp/named_req/MoveAssignable ['MoveAssignable]]]
|
|
[def __MoveConstructible__ [@https://en.cppreference.com/w/cpp/named_req/MoveConstructible ['MoveConstructible]]]
|
|
[def __Regular__ [@https://en.cppreference.com/w/cpp/concepts/regular ['Regular]]]
|
|
[def __Swappable__ [@https://en.cppreference.com/w/cpp/named_req/Swappable ['Swappable]]]
|
|
|
|
[def __array__ [link json.ref.boost__json__array `array`]]
|
|
[def __basic_parser__ [link json.ref.boost__json__basic_parser `basic_parser`]]
|
|
[def __error_category__ [link json.ref.boost__json__error_category `error_category`]]
|
|
[def __error_code__ [link json.ref.boost__json__error_code `error_code`]]
|
|
[def __error_condition__ [link json.ref.boost__json__error_condition `error_condition`]]
|
|
[def __get__ [link json.ref.boost__json__get `get`]]
|
|
[def __has_value_from__ [link json.ref.boost__json__has_value_from `has_value_from`]]
|
|
[def __has_value_to__ [link json.ref.boost__json__has_value_to `has_value_to`]]
|
|
[def __is_deallocate_trivial__ [link json.ref.boost__json__is_deallocate_trivial `is_deallocate_trivial`]]
|
|
[def __key_value_pair__ [link json.ref.boost__json__key_value_pair `key_value_pair`]]
|
|
[def __kind__ [link json.ref.boost__json__kind `kind`]]
|
|
[def __make_counted_resource__ [link json.ref.boost__json__make_counted_resource `make_counted_resource`]]
|
|
[def __memory_resource__ [link json.ref.boost__json__memory_resource `memory_resource`]]
|
|
[def __monotonic_resource__ [link json.ref.boost__json__monotonic_resource `monotonic_resource`]]
|
|
[def __null_resource__ [link json.ref.boost__json__null_resource `null_resource`]]
|
|
[def __object__ [link json.ref.boost__json__object `object`]]
|
|
[def __parse__ [link json.ref.boost__json__parse `parse`]]
|
|
[def __parser__ [link json.ref.boost__json__parser `parser`]]
|
|
[def __parse_options__ [link json.ref.boost__json__parse_options `parse_options`]]
|
|
[def __polymorphic_allocator__ [link json.ref.boost__json__polymorphic_allocator `polymorphic_allocator`]]
|
|
[def __serialize__ [link json.ref.boost__json__serialize `serialize`]]
|
|
[def __serializer__ [link json.ref.boost__json__serializer `serializer`]]
|
|
[def __static_resource__ [link json.ref.boost__json__static_resource `static_resource`]]
|
|
[def __storage_ptr__ [link json.ref.boost__json__storage_ptr `storage_ptr`]]
|
|
[def __string__ [link json.ref.boost__json__string `string`]]
|
|
[def __string_view__ [link json.ref.boost__json__string_view `string_view`]]
|
|
[def __system_error__ [link json.ref.boost__json__system_error `system_error`]]
|
|
[def __value__ [link json.ref.boost__json__value `value`]]
|
|
[def __value_from__ [link json.ref.boost__json__value_from `value_from`]]
|
|
[def __value_stack_ [link json.ref.boost__json__value_stack `value_stack`]]
|
|
[def __value_to__ [link json.ref.boost__json__value_to `value_to`]]
|
|
|
|
[def __initializer_list__ [@https://en.cppreference.com/w/cpp/utility/initializer_list `std::initializer_list`]]
|
|
[def __std_memory_resource__ [@https://en.cppreference.com/w/cpp/memory/memory_resource `std::pmr::memory_resource`]]
|
|
[def __std_polymorphic_allocator__ [@https://en.cppreference.com/w/cpp/memory/polymorphic_allocator `std::pmr::polymorphic_allocator`]]
|
|
[def __shared_ptr__ [@https://en.cppreference.com/w/cpp/memory/shared_ptr `std::shared_ptr`]]
|
|
[def __std_complex__ [@https://en.cppreference.com/w/cpp/numeric/complex `std::complex`]]
|
|
[def __std_string__ [@https://en.cppreference.com/w/cpp/string/basic_string `std::string`]]
|
|
[def __std_unordered_map__ [@https://en.cppreference.com/w/cpp/container/unordered_map `std::unordered_map`]]
|
|
[def __std_uses_allocator__ [@https://en.cppreference.com/w/cpp/memory/uses_allocator `std::uses_allocator`]]
|
|
[def __std_vector__ [@https://en.cppreference.com/w/cpp/container/vector `std::vector`]]
|
|
|
|
[/ Dingbats ]
|
|
|
|
[def __good__ [role green \u2714]]
|
|
[def __bad__ [role red \u2718]]
|
|
|
|
[/-----------------------------------------------------------------------------]
|
|
|
|
Boost.JSON is a portable C++ library which implements the
|
|
[@https://www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf JSON Data Interchange Syntax],
|
|
providing algorithms for parsing and serialization, as well as a robust
|
|
and performant container to permit inspection and modification of JSON Text
|
|
in memory.
|
|
|
|
[variablelist
|
|
[[
|
|
[link json.overview Overview]
|
|
][
|
|
A review of the requirements and features included in Boost.JSON,
|
|
rationale and design information, answers to frequently
|
|
asked questions, and credits.
|
|
]]
|
|
[[
|
|
[link json.usage Usage]
|
|
][
|
|
A quick look at how to use the library, followed by
|
|
more in-depth explanation on how each part works.
|
|
]]
|
|
[[
|
|
[link json.examples Examples]
|
|
][
|
|
Some example programs which demonstrate the use of the
|
|
library to perform various tasks.
|
|
]]
|
|
[[
|
|
[link json.comparison Comparison]
|
|
][
|
|
Compares the design and usage of this library against
|
|
many other existing libraries.
|
|
]]
|
|
[[
|
|
[link json.benchmarks Benchmarks]
|
|
][
|
|
Shows the performance of this library for typical workloads
|
|
against the performance of other comparable libraries.
|
|
]]
|
|
[[
|
|
[link json.ref Reference]
|
|
][
|
|
Detailed function and type reference.
|
|
]]
|
|
]
|
|
|
|
[/-----------------------------------------------------------------------------]
|
|
|
|
[import ../../example/pretty.cpp]
|
|
[import ../../example/validate.cpp]
|
|
[import ../../include/boost/json/impl/serialize.ipp]
|
|
[import ../../test/doc_allocators.cpp]
|
|
[import ../../test/doc_quick_look.cpp]
|
|
[import ../../test/memory_resource.cpp]
|
|
[import ../../test/snippets.cpp]
|
|
|
|
[include 01_overview.qbk]
|
|
[include 02_00_usage.qbk]
|
|
[include 03_examples.qbk]
|
|
[include 04_comparison.qbk]
|
|
[include 05_benchmarks.qbk]
|
|
|
|
[section:ref Reference]
|
|
[xinclude quickref.xml]
|
|
[include reference.qbk]
|
|
[endsect]
|
|
|
|
[xinclude index.xml]
|