mirror of
https://github.com/nlohmann/json.git
synced 2026-11-20 22:16:31 +00:00
5.8 KiB
5.8 KiB
nlohmann::basic_json::to_ubjson
// (1)
static std::vector<std::uint8_t> to_ubjson(const basic_json& j,
const bool use_size = false,
const bool use_type = false,
const error_handler_t error_handler = error_handler_t::keep);
// (2)
static void to_ubjson(const basic_json& j, detail::output_adapter<std::uint8_t> o,
const bool use_size = false, const bool use_type = false,
const error_handler_t error_handler = error_handler_t::keep);
static void to_ubjson(const basic_json& j, detail::output_adapter<char> o,
const bool use_size = false, const bool use_type = false,
const error_handler_t error_handler = error_handler_t::keep);
Serializes a given JSON value j to a byte vector using the UBJSON (Universal Binary JSON) serialization format. UBJSON
aims to be more compact than JSON itself, yet more efficient to parse.
- Returns a byte vector containing the UBJSON serialization.
- Writes the UBJSON serialization to an output adapter.
The exact mapping and its limitations are described on a dedicated page.
Parameters
j(in)- JSON value to serialize
o(in)- output adapter to write serialization to
use_size(in)- whether to add size annotations to container types; optional,
#!cpp falseby default. use_type(in)- whether to add type annotations to container types (must be combined with
#!cpp use_size = true); optional,#!cpp falseby default. error_handler(in)- how to treat a string or object key in
jthat is not valid UTF-8; seeerror_handler_t. The default,keep, writes the ill-formed bytes to the output as is, as every version ofto_ubjsondid before this parameter was added;strictthrows;replace/ignoresanitize it the same waydumpwould. IfJSON_STRICT_BINARY_UTF8is enabled, the default isstrictinstead.
Return value
- UBJSON serialization as a byte vector
- (none)
Exception safety
Strong guarantee: if an exception is thrown, there are no changes in the JSON value.
Exceptions
- Throws
other_error.502ifuse_typeis true anduse_sizeis false, andjcontains a non-empty array, object, or binary value. Scalars and empty arrays, objects, or binary values do not throw. - Throws type_error.316 if a string or object key in
jis not valid UTF-8 anderror_handlerisstrict(the default only ifJSON_STRICT_BINARY_UTF8is enabled) - Throws type_error.321 if
jor a value nested in it is discarded; example:"cannot serialize discarded value to UBJSON"
Complexity
Linear in the size of the JSON value j.
Examples
??? example "Example: serialize a JSON value to UBJSON"
The example shows the serialization of a JSON value to a byte vector in UBJSON format.
```cpp
--8<-- "examples/to_ubjson.cpp"
```
Output:
```json
--8<-- "examples/to_ubjson.output"
```
??? example "Example: other_error.502 exception"
The example shows how requesting type annotations (`use_type`) without size annotations (`use_size`) throws an
exception, because type-optimized containers can only be read back with a preceding size.
```cpp
--8<-- "examples/to_ubjson__exception.cpp"
```
Output:
```json
--8<-- "examples/to_ubjson__exception.output"
```
See also
- UBJSON - the format, its byte layout and how values are mapped
- Binary formats - overview and comparison of the supported binary formats
- Binary values - how binary values and subtypes are handled
from_ubjson- create a JSON value from an input in UBJSON formatJSON_UBJSON_VALUELESS_ELEMENTS_PER_BYTE- set how many elements of arrays ofnull,true, orfalsea reader accepts per byte of inputto_cbor- create a CBOR serialization of a JSON valueto_msgpack- create a MessagePack serialization of a JSON valueto_bson- create a BSON serialization of a JSON valueto_bjdata- create a BJData serialization of a JSON valueto_bon8- create a BON8 serialization of a JSON value
Version history
- Added in version 3.1.0.
- Added
error_handlerparameter in version 3.13.0. Its default,keep, writes the bytes of a string or object key that is not valid UTF-8 unchanged, as before;strict(the default ifJSON_STRICT_BINARY_UTF8is enabled) throwstype_error.316. - Writes arrays of
Z,T, orFwithout the$type annotation ([#n Z Z ...) once their elements in one call add up to more than 1,048,576, in version 3.13.0, so thatfrom_ubjsoncan read the output back. Such output is larger: 270,000 rows of 100nullvalues take 26.8 MB instead of 1.35 MB. The limit does not depend onJSON_UBJSON_VALUELESS_ELEMENTS_PER_BYTE: a reader accepts at least 1,048,576 elements whatever it is set to, so the writer follows that base only. - Throws
type_error.321for a discarded value since version 3.13.0; previously, a discarded value nested in an array or object was silently skipped, producing invalid UBJSON.