mirror of
https://github.com/nlohmann/json.git
synced 2026-09-28 06:10:22 +01:00
Niels Lohmann
88fbbd3aa8
Conflicts: docs/examples/to_bon8.cpp docs/examples/to_bon8.output docs/mkdocs/docs/api/basic_json/to_bon8.md include/nlohmann/detail/input/binary_reader.hpp include/nlohmann/detail/input/input_adapters.hpp include/nlohmann/detail/output/binary_writer.hpp single_include/nlohmann/json.hpp test/CMakeLists.txt tests/src/unit-binary_formats.cpp tests/src/unit-bon8.cpp
1.2 KiB
1.2 KiB
basic_json::to_bon8
// (1)
static std::vector<std::uint8_t> to_bon8(const basic_json& j);
// (2)
static void to_bon8(const basic_json& j, detail::output_adapter<std::uint8_t> o);
static void to_bon8(const basic_json& j, detail::output_adapter<char> o);
Serializes a given JSON value j to a byte vector using the BON8 serialization format. BON8 is a binary serialization
format which aims to be more compact than JSON itself, yet more efficient to parse.
- Returns a byte vector containing the BON8 serialization.
- Writes the BON8 serialization to an output adapter.
Parameters
j(in)- JSON value to serialize
o(in)- output adapter to write serialization to
Return value
- BON8 serialization as byte vector
- /
Exception safety
Strong guarantee: if an exception is thrown, there are no changes in the JSON value.
Complexity
Linear in the size of the JSON value j.
Example
??? example
The example shows the serialization of a JSON value to a byte vector in BON8 format.
```cpp
--8<-- "examples/to_bon8.cpp"
```
Output:
```json
--8<-- "examples/to_bon8.output"
```
Version history
- Added in version 3.11.0.