This library focuses on a common and popular use-case: parsing and serializing
to and from a container called
value which holds JSON types. Any
which you build can be serialized and then deserialized, guaranteeing that
the result will be equal to the original value. Whatever JSON output you produce
with this library will be readable by most common JSON implementations in any
container is designed to be well suited as a vocabulary type appropriate for
use in public interfaces and libraries, allowing them to be composed. The library
restricts the representable data types to the ranges which are almost universally
serializer are both highly performant, meeting or exceeding the benchmark performance
of the best comparable libraries. Allocators are very well supported. Code
which uses these types will be easy to understand, flexible, and performant.
Boost.JSON offers these features:
The library relies heavily on these well known C++ types in its interfaces (henceforth termed standard types):
The requirements for Boost.JSON depend on whether the library is used as part of Boost, or in the standalone flavor (without Boost):
When using without Boost, support for
is required. In particular, if using libstdc++ then version 8.3 or later
To use as header-only; that is, to eliminate the requirement to link a program to a static or dynamic Boost.JSON library, simply place the following line in exactly one new or existing source file in your project.
To build a standalone shared library, it is necessary to define the macros
BOOST_JSON_CLASS_DECL as appropriate for
your toolchain. Example for MSVC:
// When building the DLL #define BOOST_JSON_DECL __declspec(dllexport) #define BOOST_JSON_CLASS_DECL __declspec(dllexport) // When building the application which uses the DLL #define BOOST_JSON_DECL __declspec(dllimport) #define BOOST_JSON_CLASS_DECL __declspec(dllimport)
Boost.JSON works great on embedded devices. The library uses local stack buffers to increase the performance of some operations. On Intel platforms these buffers are large (4KB), while on non-Intel platforms they are small (256 bytes). To adjust the size of the stack buffers for embedded applications define this macro when building the library or including the function definitions:
#define BOOST_JSON_STACK_BUFFER_SIZE 1024 #include <boost/json/src.hpp>
This library uses separate inline namespacing for the standalone mode to allow libraries which use different modes to compose without causing link errors. Linking to both modes of Boost.JSON (Boost and standalone) is possible, but not recommended.
Boost.JSON has been tested with the following compilers:
The development infrastructure for the library includes these per-commit analyses:
This library wouldn't be where it is today without the help of Peter Dimov for design advice and optimization assistance.