WhisperCom/doc/mkdocs/docs/api/basic_json/to_cbor.md
Dominik Meyer cc002ebfbb Squashed 'libs/json/' content from commit f42a74b8
git-subtree-dir: libs/json
git-subtree-split: f42a74b8f53cc308647123d49d33d1c8122e3f42
2021-08-22 01:28:31 +02:00

1.3 KiB

basic_json::to_cbor

// (1)
static std::vector<std::uint8_t> to_cbor(const basic_json& j);

// (2)
static void to_cbor(const basic_json& j, detail::output_adapter<std::uint8_t> o);
static void to_cbor(const basic_json& j, detail::output_adapter<char> o);

Serializes a given JSON value j to a byte vector using the CBOR (Concise Binary Object Representation) serialization format. CBOR is a binary serialization format which aims to be more compact than JSON itself, yet more efficient to parse.

  1. Returns a byte vector containing the CBOR serialization.
  2. Writes the CBOR serialization to an output adapter.

Parameters

j (in)
JSON value to serialize
o (in)
output adapter to write serialization to

Return value

  1. CBOR serialization as byte vector
  2. /

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 CBOR format.
 
```cpp
--8<-- "examples/to_cbor.cpp"
```

Output:

```json
--8<-- "examples/to_cbor.output"
```

Version history

  • Added in version 2.0.9.
  • Compact representation of floating-point numbers added in version 3.8.0.