mirror of
https://github.com/nlohmann/json
synced 2024-11-25 21:30:06 +00:00
📝 make examples collapsible
This commit is contained in:
Niels Lohmann
parent
ddf92606ab
commit
95a3c76643
@ -9,7 +9,7 @@ prepare_files: clean
|
||||
# create subfolders
|
||||
mkdir docs/images docs/examples
|
||||
# copy images
|
||||
cp -vr ../json.gif docs/images
|
||||
cp -vr ../json.gif ../images/range-begin-end.svg ../images/range-rbegin-rend.svg docs/images
|
||||
# copy examples
|
||||
cp -vr ../examples/*.cpp ../examples/*.output docs/examples
|
||||
|
||||
|
||||
@ -36,7 +36,7 @@ binary | *any value* | binary | 0x05
|
||||
and the keys may not contain U+0000, since they are serialized a
|
||||
zero-terminated c-strings.
|
||||
|
||||
!!! example
|
||||
??? example
|
||||
|
||||
```cpp
|
||||
--8<-- "examples/to_bson.cpp"
|
||||
@ -81,7 +81,7 @@ Min Key | 0xFF | *unsupported*
|
||||
The mapping is **incomplete**. The unsupported mappings are indicated in the table above.
|
||||
|
||||
|
||||
!!! example
|
||||
??? example
|
||||
|
||||
```cpp
|
||||
--8<-- "examples/from_bson.cpp"
|
||||
|
||||
@ -84,7 +84,7 @@ binary | *size*: 4294967296..18446744073709551615 | byte string (8 by
|
||||
- half-precision floats (0xF9)
|
||||
- break (0xFF)
|
||||
|
||||
!!! example
|
||||
??? example
|
||||
|
||||
```cpp
|
||||
--8<-- "examples/to_cbor.cpp"
|
||||
@ -159,7 +159,7 @@ Double-Precision Float | number_float | 0xFB
|
||||
|
||||
CBOR allows map keys of any type, whereas JSON only allows strings as keys in object values. Therefore, CBOR maps with keys other than UTF-8 strings are rejected.
|
||||
|
||||
!!! example
|
||||
??? example
|
||||
|
||||
```cpp
|
||||
--8<-- "examples/from_cbor.cpp"
|
||||
|
||||
@ -5,7 +5,7 @@ Though JSON is a ubiquitous data format, it is not a very compact format suitabl
|
||||
- [BSON](bson.md) (Binary JSON),
|
||||
- [CBOR](cbor.md) (Concise Binary Object Representation),
|
||||
- [MessagePack](messagepack.md), and
|
||||
- [UBJSON](ubjson.md) (Universal Binary JSON Specification)
|
||||
- [UBJSON](ubjson.md) (Universal Binary JSON)
|
||||
|
||||
to efficiently encode JSON values to byte vectors and to decode such vectors.
|
||||
|
||||
@ -29,6 +29,8 @@ to efficiently encode JSON values to byte vectors and to decode such vectors.
|
||||
| MessagePack | supported | supported |
|
||||
| UBJSON | not supported | not supported |
|
||||
|
||||
See [binary values](../binary_values.md) for more information.
|
||||
|
||||
### Sizes
|
||||
|
||||
| Format | canada.json | twitter.json | citm_catalog.json | jeopardy.json |
|
||||
@ -39,3 +41,5 @@ to efficiently encode JSON values to byte vectors and to decode such vectors.
|
||||
| UBJSON | 53,2 % | 91,3 % | 78,2 % | 96,6 % |
|
||||
| UBJSON (size) | 58,6 % | 92,3 % | 86,8 % | 97,4 % |
|
||||
| UBJSON (size+type) | 55,9 % | 92,3 % | 85,0 % | 95,0 % |
|
||||
|
||||
Sizes compared to minified JSON value.
|
||||
|
||||
@ -69,7 +69,7 @@ binary | *size*: 65536..4294967295 | bin 32 | 0xC6
|
||||
|
||||
If NaN or Infinity are stored inside a JSON number, they are serialized properly. function which serializes NaN or Infinity to `null`.
|
||||
|
||||
!!! example
|
||||
??? example
|
||||
|
||||
```cpp
|
||||
--8<-- "examples/to_msgpack.cpp"
|
||||
@ -129,7 +129,7 @@ negative fixint | number_integer | 0xE0-0xFF
|
||||
Any MessagePack output created by `to_msgpack` can be successfully parsed by `from_msgpack`.
|
||||
|
||||
|
||||
!!! example
|
||||
??? example
|
||||
|
||||
```cpp
|
||||
--8<-- "examples/from_msgpack.cpp"
|
||||
|
||||
@ -81,7 +81,7 @@ object | *see notes on optimized format* | map | `{`
|
||||
different JSON object.
|
||||
|
||||
|
||||
!!! example
|
||||
??? example
|
||||
|
||||
```cpp
|
||||
--8<-- "examples/to_ubjson.cpp"
|
||||
@ -120,7 +120,7 @@ object | object (optimized values are supported) | `{`
|
||||
The mapping is **complete** in the sense that any UBJSON value can be converted to a JSON value.
|
||||
|
||||
|
||||
!!! example
|
||||
??? example
|
||||
|
||||
```cpp
|
||||
--8<-- "examples/from_ubjson.cpp"
|
||||
|
||||
@ -88,7 +88,7 @@ Binary values are serialized differently according to the formats.
|
||||
|
||||
JSON does not have a binary type, and this library does not introduce a new type as this would break conformance. Instead, binary values are serialized as an object with two keys: `bytes` holds an array of integers, and `subtype` is an integer or `null`.
|
||||
|
||||
!!! example
|
||||
??? example
|
||||
|
||||
Code:
|
||||
|
||||
@ -120,7 +120,7 @@ JSON does not have a binary type, and this library does not introduce a new type
|
||||
|
||||
[BSON](binary_formats/bson.md) supports binary values and subtypes. If a subtype is given, it is used and added as unsigned 8-bit integer. If no subtype is given, the generic binary subtype 0x00 is used.
|
||||
|
||||
!!! example
|
||||
??? example
|
||||
|
||||
Code:
|
||||
|
||||
@ -160,7 +160,7 @@ JSON does not have a binary type, and this library does not introduce a new type
|
||||
|
||||
[CBOR](binary_formats/cbor.md) supports binary values, but no subtypes. Any binary value will be serialized as byte strings. The library will choose the smallest representation using the length of the byte array.
|
||||
|
||||
!!! example
|
||||
??? example
|
||||
|
||||
Code:
|
||||
|
||||
@ -200,7 +200,7 @@ JSON does not have a binary type, and this library does not introduce a new type
|
||||
|
||||
If no subtype is given, the bin family (bin8, bin16, bin32) is used.
|
||||
|
||||
!!! example
|
||||
??? example
|
||||
|
||||
Code:
|
||||
|
||||
@ -239,7 +239,7 @@ If no subtype is given, the bin family (bin8, bin16, bin32) is used.
|
||||
|
||||
[UBJSON](binary_formats/ubjson.md) neither supports binary values nor subtypes, and proposes to serialize binary values as array of uint8 values. This translation is implemented by the library.
|
||||
|
||||
!!! example
|
||||
??? example
|
||||
|
||||
Code:
|
||||
|
||||
|
||||
129
doc/mkdocs/docs/features/iterators.md
Normal file
129
doc/mkdocs/docs/features/iterators.md
Normal file
@ -0,0 +1,129 @@
|
||||
# Iterators
|
||||
|
||||
## Overview
|
||||
|
||||
A JSON value is a container and allows access via iterators.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Iterator getters
|
||||
|
||||
### `begin()`
|
||||
|
||||
??? example
|
||||
|
||||
The following code shows an example for `begin()`.
|
||||
|
||||
```cpp
|
||||
--8<-- "examples/begin.cpp"
|
||||
```
|
||||
|
||||
Output:
|
||||
|
||||
```json
|
||||
--8<-- "examples/begin.output"
|
||||
```
|
||||
|
||||
### `cbegin()`
|
||||
|
||||
??? example
|
||||
|
||||
The following code shows an example for `cbegin()`.
|
||||
|
||||
```cpp
|
||||
--8<-- "examples/cbegin.cpp"
|
||||
```
|
||||
|
||||
Output:
|
||||
|
||||
```json
|
||||
--8<-- "examples/cbegin.output"
|
||||
```
|
||||
|
||||
### `end()`
|
||||
|
||||
??? example
|
||||
|
||||
The following code shows an example for `end()`.
|
||||
|
||||
```cpp
|
||||
--8<-- "examples/end.cpp"
|
||||
```
|
||||
|
||||
Output:
|
||||
|
||||
```json
|
||||
--8<-- "examples/end.output"
|
||||
```
|
||||
|
||||
### `cend()`
|
||||
|
||||
??? example
|
||||
|
||||
The following code shows an example for `cend()`.
|
||||
|
||||
```cpp
|
||||
--8<-- "examples/cend.cpp"
|
||||
```
|
||||
|
||||
Output:
|
||||
|
||||
```json
|
||||
--8<-- "examples/cend.output"
|
||||
```
|
||||
|
||||
### `rbegin()`
|
||||
|
||||
??? example
|
||||
|
||||
The following code shows an example for `rbegin()`.
|
||||
|
||||
```cpp
|
||||
--8<-- "examples/rbegin.cpp"
|
||||
```
|
||||
|
||||
Output:
|
||||
|
||||
```json
|
||||
--8<-- "examples/rbegin.output"
|
||||
```
|
||||
|
||||
### `rend()`
|
||||
|
||||
??? example
|
||||
|
||||
The following code shows an example for `rend()`.
|
||||
|
||||
```cpp
|
||||
--8<-- "examples/rend.cpp"
|
||||
```
|
||||
|
||||
Output:
|
||||
|
||||
```json
|
||||
--8<-- "examples/rend.output"
|
||||
```
|
||||
|
||||
### `items()`
|
||||
|
||||
??? example
|
||||
|
||||
The following code shows an example for `items()`.
|
||||
|
||||
```cpp
|
||||
--8<-- "examples/items.cpp"
|
||||
```
|
||||
|
||||
Output:
|
||||
|
||||
```
|
||||
--8<-- "examples/items.output"
|
||||
```
|
||||
|
||||
## Iterator invalidation
|
||||
|
||||
| Operations | invalidated iterators |
|
||||
| ---------- | --------------------- |
|
||||
| `clear` | all |
|
||||
@ -1,28 +1,45 @@
|
||||
# JSON Patch
|
||||
# JSON Patch and Diff
|
||||
|
||||
On top of this, **JSON Patch** ([RFC 6902](https://tools.ietf.org/html/rfc6902)) allows to describe differences between two JSON values - effectively allowing patch and diff operations known from Unix.
|
||||
## Patches
|
||||
|
||||
JSON Patch ([RFC 6902](https://tools.ietf.org/html/rfc6902)) defines a JSON document structure for expressing a sequence of operations to apply to a JSON) document. With the `patch` function, a JSON Patch is applied to the current JSON value by executing all operations from the patch.
|
||||
|
||||
??? example
|
||||
|
||||
The following code shows how a JSON patch is applied to a value.
|
||||
|
||||
```cpp
|
||||
|
||||
// a JSON patch (RFC 6902)
|
||||
json j_patch = R"([
|
||||
{ "op": "replace", "path": "/baz", "value": "boo" },
|
||||
{ "op": "add", "path": "/hello", "value": ["world"] },
|
||||
{ "op": "remove", "path": "/foo"}
|
||||
])"_json;
|
||||
|
||||
// apply the patch
|
||||
json j_result = j_original.patch(j_patch);
|
||||
// {
|
||||
// "baz": "boo",
|
||||
// "hello": ["world"]
|
||||
// }
|
||||
|
||||
// calculate a JSON patch from two JSON values
|
||||
json::diff(j_result, j_original);
|
||||
// [
|
||||
// { "op":" replace", "path": "/baz", "value": ["one", "two", "three"] },
|
||||
// { "op": "remove","path": "/hello" },
|
||||
// { "op": "add", "path": "/foo", "value": "bar" }
|
||||
// ]
|
||||
--8<-- "examples/patch.cpp"
|
||||
```
|
||||
|
||||
Output:
|
||||
|
||||
```json
|
||||
--8<-- "examples/patch.output"
|
||||
```
|
||||
|
||||
## Diff
|
||||
|
||||
The library can also calculate a JSON patch (i.e., a **diff**) given two JSON values.
|
||||
|
||||
!!! success "Invariant"
|
||||
|
||||
For two JSON values *source* and *target*, the following code yields always true:
|
||||
|
||||
```cüü
|
||||
source.patch(diff(source, target)) == target;
|
||||
```
|
||||
|
||||
??? example
|
||||
|
||||
The following code shows how a JSON patch is created as a diff for two JSON values.
|
||||
|
||||
```cpp
|
||||
--8<-- "examples/diff.cpp"
|
||||
```
|
||||
|
||||
Output:
|
||||
|
||||
```json
|
||||
--8<-- "examples/diff.output"
|
||||
```
|
||||
|
||||
@ -1,31 +1,20 @@
|
||||
# JSON Merge Patch
|
||||
|
||||
The library supports **JSON Merge Patch** ([RFC 7386](https://tools.ietf.org/html/rfc7386)) as a patch format. Instead of using JSON Pointer (see above) to specify values to be manipulated, it describes the changes using a syntax that closely mimics the document being modified.
|
||||
The library supports JSON Merge Patch ([RFC 7386](https://tools.ietf.org/html/rfc7386)) as a patch format.
|
||||
The merge patch format is primarily intended for use with the HTTP PATCH method as a means of describing a set of modifications to a target resource's content. This function applies a merge patch to the current JSON value.
|
||||
|
||||
Instead of using [JSON Pointer](json_pointer.md) to specify values to be manipulated, it describes the changes using a syntax that closely mimics the document being modified.
|
||||
|
||||
??? example
|
||||
|
||||
The following code shows how a JSON Merge Patch is applied to a JSON document.
|
||||
|
||||
```cpp
|
||||
// a JSON value
|
||||
json j_document = R"({
|
||||
"a": "b",
|
||||
"c": {
|
||||
"d": "e",
|
||||
"f": "g"
|
||||
}
|
||||
})"_json;
|
||||
|
||||
// a patch
|
||||
json j_patch = R"({
|
||||
"a":"z",
|
||||
"c": {
|
||||
"f": null
|
||||
}
|
||||
})"_json;
|
||||
|
||||
// apply the patch
|
||||
j_document.merge_patch(j_patch);
|
||||
// {
|
||||
// "a": "z",
|
||||
// "c": {
|
||||
// "d": "e"
|
||||
// }
|
||||
// }
|
||||
--8<-- "examples/merge_patch.cpp"
|
||||
```
|
||||
|
||||
Output:
|
||||
|
||||
```json
|
||||
--8<-- "examples/merge_patch.output"
|
||||
```
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
The library uses a SAX-like interface with the following functions:
|
||||
|
||||
```plantuml
|
||||
class sax {
|
||||
interface json::sax_t {
|
||||
+ {abstract} bool null()
|
||||
|
||||
+ {abstract} bool boolean(bool val)
|
||||
|
||||
@ -17,6 +17,8 @@ By default, JSON values are stored as follows:
|
||||
|
||||
Note there are three different types for numbers - when parsing JSON text, the best fitting type is chosen.
|
||||
|
||||
## Storage
|
||||
|
||||
```plantuml
|
||||
enum value_t {
|
||||
null
|
||||
@ -44,8 +46,10 @@ class json_value << (U,orchid) >> {
|
||||
}
|
||||
|
||||
class basic_json {
|
||||
-- type and value --
|
||||
value_t m_type
|
||||
json_value m_value
|
||||
-- derived types --
|
||||
+ <u>typedef</u> object_t
|
||||
+ <u>typedef</u> array_t
|
||||
+ <u>typedef</u> binary_t
|
||||
|
||||
@ -6,6 +6,26 @@
|
||||
|
||||
All exceptions inherit from class `json::exception` (which in turn inherits from `std::exception`). It is used as the base class for all exceptions thrown by the `basic_json` class. This class can hence be used as "wildcard" to catch exceptions.
|
||||
|
||||
```plantuml
|
||||
std::exception <|-- json::exception
|
||||
json::exception <|-- json::parse_error
|
||||
json::exception <|-- json::invalid_iterator
|
||||
json::exception <|-- json::type_error
|
||||
json::exception <|-- json::out_of_range
|
||||
json::exception <|-- json::other_error
|
||||
|
||||
interface std::exception {}
|
||||
|
||||
class json::exception {
|
||||
+ const int id
|
||||
+ const char* what() const
|
||||
}
|
||||
|
||||
class json::parse_error {
|
||||
+ const std::size_t byte
|
||||
}
|
||||
```
|
||||
|
||||
### Switch off exceptions
|
||||
|
||||
Exceptions are used widely within the library. They can, however, be switched off with either using the compiler flag `-fno-exceptions` or by defining the symbol `JSON_NOEXCEPTION`. In this case, exceptions are replaced by `abort()` calls. You can further control this behavior by defining `JSON_THROW_USER` (overriding `#!cpp throw`), `JSON_TRY_USER` (overriding `#!cpp try`), and `JSON_CATCH_USER` (overriding `#!cpp catch`).
|
||||
@ -29,12 +49,26 @@ Exceptions have ids 1xx.
|
||||
is the index of the terminating null byte or the end of file. This also
|
||||
holds true when reading a byte vector (CBOR or MessagePack).
|
||||
|
||||
??? example
|
||||
|
||||
The following code shows how a `parse_error` exception can be caught.
|
||||
|
||||
```cpp
|
||||
--8<-- "examples/parse_error.cpp"
|
||||
```
|
||||
|
||||
Output:
|
||||
|
||||
```
|
||||
--8<-- "examples/parse_error.output"
|
||||
```
|
||||
|
||||
|
||||
### json.exception.parse_error.101
|
||||
|
||||
This error indicates a syntax error while deserializing a JSON text. The error message describes that an unexpected token (character) was encountered, and the member `byte` indicates the error position.
|
||||
|
||||
!!! example
|
||||
!!! failure "Example message"
|
||||
|
||||
Input ended prematurely:
|
||||
|
||||
@ -93,7 +127,7 @@ This error indicates a syntax error while deserializing a JSON text. The error m
|
||||
|
||||
JSON uses the `\uxxxx` format to describe Unicode characters. Code points above above 0xFFFF are split into two `\uxxxx` entries ("surrogate pairs"). This error indicates that the surrogate pair is incomplete or contains an invalid code point.
|
||||
|
||||
!!! example
|
||||
!!! failure "Example message"
|
||||
|
||||
```
|
||||
parse error at 14: missing or wrong low surrogate
|
||||
@ -103,7 +137,7 @@ JSON uses the `\uxxxx` format to describe Unicode characters. Code points above
|
||||
|
||||
Unicode supports code points up to 0x10FFFF. Code points above 0x10FFFF are invalid.
|
||||
|
||||
!!! example
|
||||
!!! failure "Example message"
|
||||
|
||||
```
|
||||
parse error: code points above 0x10FFFF are invalid
|
||||
@ -113,7 +147,7 @@ Unicode supports code points up to 0x10FFFF. Code points above 0x10FFFF are inva
|
||||
|
||||
[RFC 6902](https://tools.ietf.org/html/rfc6902) requires a JSON Patch document to be a JSON document that represents an array of objects.
|
||||
|
||||
!!! example
|
||||
!!! failure "Example message"
|
||||
|
||||
```
|
||||
[json.exception.parse_error.104] parse error: JSON patch must be an array of objects
|
||||
@ -123,7 +157,7 @@ Unicode supports code points up to 0x10FFFF. Code points above 0x10FFFF are inva
|
||||
|
||||
An operation of a JSON Patch document must contain exactly one "op" member, whose value indicates the operation to perform. Its value must be one of "add", "remove", "replace", "move", "copy", or "test"; other values are errors.
|
||||
|
||||
!!! example
|
||||
!!! failure "Example message"
|
||||
|
||||
```
|
||||
[json.exception.parse_error.105] parse error: operation 'add' must have member 'value'
|
||||
@ -139,7 +173,7 @@ An operation of a JSON Patch document must contain exactly one "op" member, whos
|
||||
|
||||
An array index in a JSON Pointer ([RFC 6901](https://tools.ietf.org/html/rfc6901)) may be `0` or any number without a leading `0`.
|
||||
|
||||
!!! example
|
||||
!!! failure "Example message"
|
||||
|
||||
```
|
||||
[json.exception.parse_error.106] parse error: array index '01' must not begin with '0'
|
||||
@ -149,7 +183,7 @@ An array index in a JSON Pointer ([RFC 6901](https://tools.ietf.org/html/rfc6901
|
||||
|
||||
A JSON Pointer must be a Unicode string containing a sequence of zero or more reference tokens, each prefixed by a `/` character.
|
||||
|
||||
!!! example
|
||||
!!! failure "Example message"
|
||||
|
||||
```
|
||||
[json.exception.parse_error.107] parse error at byte 1: JSON pointer must be empty or begin with '/' - was: 'foo'
|
||||
@ -159,7 +193,7 @@ A JSON Pointer must be a Unicode string containing a sequence of zero or more re
|
||||
|
||||
In a JSON Pointer, only `~0` and `~1` are valid escape sequences.
|
||||
|
||||
!!! example
|
||||
!!! failure "Example message"
|
||||
|
||||
```
|
||||
[json.exception.parse_error.108] parse error: escape character '~' must be followed with '0' or '1'
|
||||
@ -169,7 +203,7 @@ In a JSON Pointer, only `~0` and `~1` are valid escape sequences.
|
||||
|
||||
A JSON Pointer array index must be a number.
|
||||
|
||||
!!! example
|
||||
!!! failure "Example message"
|
||||
|
||||
```
|
||||
[json.exception.parse_error.109] parse error: array index 'one' is not a number
|
||||
@ -182,7 +216,7 @@ A JSON Pointer array index must be a number.
|
||||
|
||||
When parsing CBOR or MessagePack, the byte vector ends before the complete value has been read.
|
||||
|
||||
!!! example
|
||||
!!! failure "Example message"
|
||||
|
||||
```
|
||||
[json.exception.parse_error.110] parse error at byte 5: syntax error while parsing CBOR string: unexpected end of input
|
||||
@ -195,7 +229,7 @@ When parsing CBOR or MessagePack, the byte vector ends before the complete value
|
||||
|
||||
Not all types of CBOR or MessagePack are supported. This exception occurs if an unsupported byte was read.
|
||||
|
||||
!!! example
|
||||
!!! failure "Example message"
|
||||
|
||||
```
|
||||
[json.exception.parse_error.112] parse error at byte 1: syntax error while parsing CBOR value: invalid byte: 0x1C
|
||||
@ -205,7 +239,7 @@ Not all types of CBOR or MessagePack are supported. This exception occurs if an
|
||||
|
||||
While parsing a map key, a value that is not a string has been read.
|
||||
|
||||
!!! example
|
||||
!!! failure "Example message"
|
||||
|
||||
```
|
||||
[json.exception.parse_error.113] parse error at byte 2: syntax error while parsing CBOR string: expected length specification (0x60-0x7B) or indefinite string type (0x7F); last byte: 0xFF
|
||||
@ -221,7 +255,7 @@ While parsing a map key, a value that is not a string has been read.
|
||||
|
||||
The parsing of the corresponding BSON record type is not implemented (yet).
|
||||
|
||||
!!! example
|
||||
!!! failure "Example message"
|
||||
|
||||
```
|
||||
[json.exception.parse_error.114] parse error at byte 5: Unsupported BSON record type 0xFF
|
||||
@ -234,11 +268,25 @@ the expected semantics.
|
||||
|
||||
Exceptions have ids 2xx.
|
||||
|
||||
??? example
|
||||
|
||||
The following code shows how an `invalid_iterator` exception can be caught.
|
||||
|
||||
```cpp
|
||||
--8<-- "examples/invalid_iterator.cpp"
|
||||
```
|
||||
|
||||
Output:
|
||||
|
||||
```
|
||||
--8<-- "examples/invalid_iterator.output"
|
||||
```
|
||||
|
||||
### json.exception.invalid_iterator.201
|
||||
|
||||
The iterators passed to constructor `basic_json(InputIT first, InputIT last)` are not compatible, meaning they do not belong to the same container. Therefore, the range (`first`, `last`) is invalid.
|
||||
|
||||
!!! example
|
||||
!!! failure "Example message"
|
||||
|
||||
```
|
||||
[json.exception.invalid_iterator.201] iterators are not compatible
|
||||
@ -248,7 +296,7 @@ The iterators passed to constructor `basic_json(InputIT first, InputIT last)` ar
|
||||
|
||||
In an erase or insert function, the passed iterator @a pos does not belong to the JSON value for which the function was called. It hence does not define a valid position for the deletion/insertion.
|
||||
|
||||
!!! example
|
||||
!!! failure "Example message"
|
||||
|
||||
```
|
||||
[json.exception.invalid_iterator.202] iterator does not fit current value
|
||||
@ -261,7 +309,7 @@ In an erase or insert function, the passed iterator @a pos does not belong to th
|
||||
|
||||
Either iterator passed to function `erase(IteratorType` first, IteratorType last) does not belong to the JSON value from which values shall be erased. It hence does not define a valid range to delete values from.
|
||||
|
||||
!!! example
|
||||
!!! failure "Example message"
|
||||
|
||||
```
|
||||
[json.exception.invalid_iterator.203] iterators do not fit current value
|
||||
@ -271,7 +319,7 @@ Either iterator passed to function `erase(IteratorType` first, IteratorType last
|
||||
|
||||
When an iterator range for a primitive type (number, boolean, or string) is passed to a constructor or an erase function, this range has to be exactly (`begin(),` `end()),` because this is the only way the single stored value is expressed. All other ranges are invalid.
|
||||
|
||||
!!! example
|
||||
!!! failure "Example message"
|
||||
|
||||
```
|
||||
[json.exception.invalid_iterator.204] iterators out of range
|
||||
@ -281,7 +329,7 @@ When an iterator range for a primitive type (number, boolean, or string) is pass
|
||||
|
||||
When an iterator for a primitive type (number, boolean, or string) is passed to an erase function, the iterator has to be the `begin()` iterator, because it is the only way to address the stored value. All other iterators are invalid.
|
||||
|
||||
!!! example
|
||||
!!! failure "Example message"
|
||||
|
||||
```
|
||||
[json.exception.invalid_iterator.205] iterator out of range
|
||||
@ -291,7 +339,7 @@ When an iterator for a primitive type (number, boolean, or string) is passed to
|
||||
|
||||
The iterators passed to constructor `basic_json(InputIT first, InputIT last)` belong to a JSON null value and hence to not define a valid range.
|
||||
|
||||
!!! example
|
||||
!!! failure "Example message"
|
||||
|
||||
```
|
||||
[json.exception.invalid_iterator.206] cannot construct with iterators from null
|
||||
@ -301,7 +349,7 @@ The iterators passed to constructor `basic_json(InputIT first, InputIT last)` be
|
||||
|
||||
The `key()` member function can only be used on iterators belonging to a JSON object, because other types do not have a concept of a key.
|
||||
|
||||
!!! example
|
||||
!!! failure "Example message"
|
||||
|
||||
```
|
||||
[json.exception.invalid_iterator.207] cannot use key() for non-object iterators
|
||||
@ -312,7 +360,7 @@ The `key()` member function can only be used on iterators belonging to a JSON ob
|
||||
|
||||
The `operator[]` to specify a concrete offset cannot be used on iterators belonging to a JSON object, because JSON objects are unordered.
|
||||
|
||||
!!! example
|
||||
!!! failure "Example message"
|
||||
|
||||
```
|
||||
[json.exception.invalid_iterator.208] cannot use operator[] for object iterators
|
||||
@ -322,7 +370,7 @@ The `operator[]` to specify a concrete offset cannot be used on iterators belong
|
||||
|
||||
The offset operators (`+`, `-`, `+=`, `-=`) cannot be used on iterators belonging to a JSON object, because JSON objects are unordered.
|
||||
|
||||
!!! example
|
||||
!!! failure "Example message"
|
||||
|
||||
```
|
||||
[json.exception.invalid_iterator.209] cannot use offsets with object iterators
|
||||
@ -332,7 +380,7 @@ The offset operators (`+`, `-`, `+=`, `-=`) cannot be used on iterators belongin
|
||||
|
||||
The iterator range passed to the insert function are not compatible, meaning they do not belong to the same container. Therefore, the range (`first`, `last`) is invalid.
|
||||
|
||||
!!! example
|
||||
!!! failure "Example message"
|
||||
|
||||
```
|
||||
[json.exception.invalid_iterator.210] iterators do not fit
|
||||
@ -342,7 +390,7 @@ The iterator range passed to the insert function are not compatible, meaning the
|
||||
|
||||
The iterator range passed to the insert function must not be a subrange of the container to insert to.
|
||||
|
||||
!!! example
|
||||
!!! failure "Example message"
|
||||
|
||||
```
|
||||
[json.exception.invalid_iterator.211] passed iterators may not belong to container
|
||||
@ -352,7 +400,7 @@ The iterator range passed to the insert function must not be a subrange of the c
|
||||
|
||||
When two iterators are compared, they must belong to the same container.
|
||||
|
||||
!!! example
|
||||
!!! failure "Example message"
|
||||
|
||||
```
|
||||
[json.exception.invalid_iterator.212] cannot compare iterators of different containers
|
||||
@ -362,7 +410,7 @@ When two iterators are compared, they must belong to the same container.
|
||||
|
||||
The order of object iterators cannot be compared, because JSON objects are unordered.
|
||||
|
||||
!!! example
|
||||
!!! failure "Example message"
|
||||
|
||||
```
|
||||
[json.exception.invalid_iterator.213] cannot compare order of object iterators
|
||||
@ -372,7 +420,7 @@ The order of object iterators cannot be compared, because JSON objects are unord
|
||||
|
||||
Cannot get value for iterator: Either the iterator belongs to a null value or it is an iterator to a primitive type (number, boolean, or string), but the iterator is different to `begin()`.
|
||||
|
||||
!!! example
|
||||
!!! failure "Example message"
|
||||
|
||||
```
|
||||
[json.exception.invalid_iterator.214] cannot get value
|
||||
@ -385,12 +433,25 @@ This exception is thrown in case of a type error; that is, a library function is
|
||||
|
||||
Exceptions have ids 3xx.
|
||||
|
||||
??? example
|
||||
|
||||
The following code shows how a `type_error` exception can be caught.
|
||||
|
||||
```cpp
|
||||
--8<-- "examples/type_error.cpp"
|
||||
```
|
||||
|
||||
Output:
|
||||
|
||||
```
|
||||
--8<-- "examples/type_error.output"
|
||||
```
|
||||
|
||||
### json.exception.type_error.301
|
||||
|
||||
To create an object from an initializer list, the initializer list must consist only of a list of pairs whose first element is a string. When this constraint is violated, an array is created instead.
|
||||
|
||||
!!! example
|
||||
!!! failure "Example message"
|
||||
|
||||
```
|
||||
[json.exception.type_error.301] cannot create object from initializer list
|
||||
@ -400,7 +461,7 @@ To create an object from an initializer list, the initializer list must consist
|
||||
|
||||
During implicit or explicit value conversion, the JSON type must be compatible to the target type. For instance, a JSON string can only be converted into string types, but not into numbers or boolean types.
|
||||
|
||||
!!! example
|
||||
!!! failure "Example message"
|
||||
|
||||
```
|
||||
[json.exception.type_error.302] type must be object, but is null
|
||||
@ -413,7 +474,7 @@ During implicit or explicit value conversion, the JSON type must be compatible t
|
||||
|
||||
To retrieve a reference to a value stored in a `basic_json` object with `get_ref`, the type of the reference must match the value type. For instance, for a JSON array, the `ReferenceType` must be `array_t &`.
|
||||
|
||||
!!! example
|
||||
!!! failure "Example message"
|
||||
|
||||
```
|
||||
[json.exception.type_error.303] incompatible ReferenceType for get_ref, actual type is object
|
||||
@ -426,7 +487,7 @@ To retrieve a reference to a value stored in a `basic_json` object with `get_ref
|
||||
|
||||
The `at()` member functions can only be executed for certain JSON types.
|
||||
|
||||
!!! example
|
||||
!!! failure "Example message"
|
||||
|
||||
```
|
||||
[json.exception.type_error.304] cannot use at() with string
|
||||
@ -439,7 +500,7 @@ The `at()` member functions can only be executed for certain JSON types.
|
||||
|
||||
The `operator[]` member functions can only be executed for certain JSON types.
|
||||
|
||||
!!! example
|
||||
!!! failure "Example message"
|
||||
|
||||
```
|
||||
[json.exception.type_error.305] cannot use operator[] with a string argument with array
|
||||
@ -452,7 +513,7 @@ The `operator[]` member functions can only be executed for certain JSON types.
|
||||
|
||||
The `value()` member functions can only be executed for certain JSON types.
|
||||
|
||||
!!! example
|
||||
!!! failure "Example message"
|
||||
|
||||
```
|
||||
[json.exception.type_error.306] cannot use value() with number
|
||||
@ -462,7 +523,7 @@ The `value()` member functions can only be executed for certain JSON types.
|
||||
|
||||
The `erase()` member functions can only be executed for certain JSON types.
|
||||
|
||||
!!! example
|
||||
!!! failure "Example message"
|
||||
|
||||
```
|
||||
[json.exception.type_error.307] cannot use erase() with string
|
||||
@ -472,7 +533,7 @@ The `erase()` member functions can only be executed for certain JSON types.
|
||||
|
||||
The `push_back()` and `operator+=` member functions can only be executed for certain JSON types.
|
||||
|
||||
!!! example
|
||||
!!! failure "Example message"
|
||||
|
||||
```
|
||||
[json.exception.type_error.308] cannot use push_back() with string
|
||||
@ -482,7 +543,7 @@ The `push_back()` and `operator+=` member functions can only be executed for cer
|
||||
|
||||
The `insert()` member functions can only be executed for certain JSON types.
|
||||
|
||||
!!! example
|
||||
!!! failure "Example message"
|
||||
|
||||
```
|
||||
[json.exception.type_error.309] cannot use insert() with array
|
||||
@ -495,7 +556,7 @@ The `insert()` member functions can only be executed for certain JSON types.
|
||||
|
||||
The `swap()` member functions can only be executed for certain JSON types.
|
||||
|
||||
!!! example
|
||||
!!! failure "Example message"
|
||||
|
||||
```
|
||||
[json.exception.type_error.310] cannot use swap() with number
|
||||
@ -505,7 +566,7 @@ The `swap()` member functions can only be executed for certain JSON types.
|
||||
|
||||
The `emplace()` and `emplace_back()` member functions can only be executed for certain JSON types.
|
||||
|
||||
!!! example
|
||||
!!! failure "Example message"
|
||||
|
||||
```
|
||||
[json.exception.type_error.311] cannot use emplace() with number
|
||||
@ -518,7 +579,7 @@ The `emplace()` and `emplace_back()` member functions can only be executed for c
|
||||
|
||||
The `update()` member functions can only be executed for certain JSON types.
|
||||
|
||||
!!! example
|
||||
!!! failure "Example message"
|
||||
|
||||
```
|
||||
[json.exception.type_error.312] cannot use update() with array
|
||||
@ -528,7 +589,7 @@ The `update()` member functions can only be executed for certain JSON types.
|
||||
|
||||
The `unflatten` function converts an object whose keys are JSON Pointers back into an arbitrary nested JSON value. The JSON Pointers must not overlap, because then the resulting value would not be well defined.
|
||||
|
||||
!!! example
|
||||
!!! failure "Example message"
|
||||
|
||||
```
|
||||
[json.exception.type_error.313] invalid value to unflatten
|
||||
@ -538,7 +599,7 @@ The `unflatten` function converts an object whose keys are JSON Pointers back in
|
||||
|
||||
The `unflatten` function only works for an object whose keys are JSON Pointers.
|
||||
|
||||
!!! example
|
||||
!!! failure "Example message"
|
||||
|
||||
Calling `unflatten()` on an array `#!json [1,2,3]`:
|
||||
|
||||
@ -550,7 +611,7 @@ The `unflatten` function only works for an object whose keys are JSON Pointers.
|
||||
|
||||
The `unflatten()` function only works for an object whose keys are JSON Pointers and whose values are primitive.
|
||||
|
||||
!!! example
|
||||
!!! failure "Example message"
|
||||
|
||||
Calling `unflatten()` on an object `#!json {"/1", [1,2,3]}`:
|
||||
|
||||
@ -562,7 +623,7 @@ The `unflatten()` function only works for an object whose keys are JSON Pointers
|
||||
|
||||
The `dump()` function only works with UTF-8 encoded strings; that is, if you assign a `std::string` to a JSON value, make sure it is UTF-8 encoded.
|
||||
|
||||
!!! example
|
||||
!!! failure "Example message"
|
||||
|
||||
Calling `dump()` on a JSON value containing an ISO 8859-1 encoded string:
|
||||
```
|
||||
@ -580,7 +641,7 @@ The `dump()` function only works with UTF-8 encoded strings; that is, if you ass
|
||||
|
||||
The dynamic type of the object cannot be represented in the requested serialization format (e.g. a raw `true` or `null` JSON object cannot be serialized to BSON)
|
||||
|
||||
!!! example
|
||||
!!! failure "Example message"
|
||||
|
||||
Serializing `#!json null` to BSON:
|
||||
```
|
||||
@ -602,12 +663,25 @@ This exception is thrown in case a library function is called on an input parame
|
||||
|
||||
Exceptions have ids 4xx.
|
||||
|
||||
??? example
|
||||
|
||||
The following code shows how an `out_of_range` exception can be caught.
|
||||
|
||||
```cpp
|
||||
--8<-- "examples/out_of_range.cpp"
|
||||
```
|
||||
|
||||
Output:
|
||||
|
||||
```
|
||||
--8<-- "examples/out_of_range.output"
|
||||
```
|
||||
|
||||
### json.exception.out_of_range.401
|
||||
|
||||
The provided array index `i` is larger than `size-1`.
|
||||
|
||||
!!! example
|
||||
!!! failure "Example message"
|
||||
|
||||
```
|
||||
array index 3 is out of range
|
||||
@ -617,7 +691,7 @@ The provided array index `i` is larger than `size-1`.
|
||||
|
||||
The special array index `-` in a JSON Pointer never describes a valid element of the array, but the index past the end. That is, it can only be used to add elements at this position, but not to read it.
|
||||
|
||||
!!! example
|
||||
!!! failure "Example message"
|
||||
|
||||
```
|
||||
array index '-' (3) is out of range
|
||||
@ -627,7 +701,7 @@ The special array index `-` in a JSON Pointer never describes a valid element of
|
||||
|
||||
The provided key was not found in the JSON object.
|
||||
|
||||
!!! example
|
||||
!!! failure "Example message"
|
||||
|
||||
```
|
||||
key 'foo' not found
|
||||
@ -637,7 +711,7 @@ The provided key was not found in the JSON object.
|
||||
|
||||
A reference token in a JSON Pointer could not be resolved.
|
||||
|
||||
!!! example
|
||||
!!! failure "Example message"
|
||||
|
||||
```
|
||||
unresolved reference token 'foo'
|
||||
@ -647,7 +721,7 @@ A reference token in a JSON Pointer could not be resolved.
|
||||
|
||||
The JSON Patch operations 'remove' and 'add' can not be applied to the root element of the JSON value.
|
||||
|
||||
!!! example
|
||||
!!! failure "Example message"
|
||||
|
||||
```
|
||||
JSON pointer has no parent
|
||||
@ -657,7 +731,7 @@ The JSON Patch operations 'remove' and 'add' can not be applied to the root elem
|
||||
|
||||
A parsed number could not be stored as without changing it to NaN or INF.
|
||||
|
||||
!!! example
|
||||
!!! failure "Example message"
|
||||
|
||||
```
|
||||
number overflow parsing '10E1000'
|
||||
@ -667,7 +741,7 @@ A parsed number could not be stored as without changing it to NaN or INF.
|
||||
|
||||
UBJSON and BSON only support integer numbers up to 9223372036854775807.
|
||||
|
||||
!!! example
|
||||
!!! failure "Example message"
|
||||
|
||||
```
|
||||
number overflow serializing '9223372036854775808'
|
||||
@ -677,7 +751,7 @@ UBJSON and BSON only support integer numbers up to 9223372036854775807.
|
||||
|
||||
The size (following `#`) of an UBJSON array or object exceeds the maximal capacity.
|
||||
|
||||
!!! example
|
||||
!!! failure "Example message"
|
||||
|
||||
```
|
||||
excessive array size: 8658170730974374167
|
||||
@ -687,7 +761,7 @@ The size (following `#`) of an UBJSON array or object exceeds the maximal capaci
|
||||
|
||||
Key identifiers to be serialized to BSON cannot contain code point U+0000, since the key is stored as zero-terminated c-string.
|
||||
|
||||
!!! example
|
||||
!!! failure "Example message"
|
||||
|
||||
```
|
||||
BSON key cannot contain code point U+0000 (at byte 2)
|
||||
@ -700,11 +774,25 @@ other exception types.
|
||||
|
||||
Exceptions have ids 5xx.
|
||||
|
||||
??? example
|
||||
|
||||
The following code shows how an `other_error` exception can be caught.
|
||||
|
||||
```cpp
|
||||
--8<-- "examples/other_error.cpp"
|
||||
```
|
||||
|
||||
Output:
|
||||
|
||||
```
|
||||
--8<-- "examples/other_error.output"
|
||||
```
|
||||
|
||||
### json.exception.other_error.501
|
||||
|
||||
A JSON Patch operation 'test' failed. The unsuccessful operation is also printed.
|
||||
|
||||
!!! example
|
||||
!!! failure "Example message"
|
||||
|
||||
Executing `#!json {"op":"test", "path":"/baz", "value":"bar"}` on `#!json {"baz": "qux"}`:
|
||||
|
||||
|
||||
@ -44,6 +44,7 @@ nav:
|
||||
- features/binary_formats/messagepack.md
|
||||
- features/binary_formats/ubjson.md
|
||||
- features/binary_values.md
|
||||
- features/iterators.md
|
||||
- features/json_pointer.md
|
||||
- features/json_patch.md
|
||||
- features/merge_patch.md
|
||||
|
||||
Loading…
Reference in New Issue
Block a user