mirror of
https://github.com/nlohmann/json.git
synced 2026-04-11 18:48:52 +00:00
📝 fix and extend documentation of discarded values
This commit is contained in:
@@ -4,9 +4,12 @@
|
||||
constexpr bool is_discarded() const noexcept;
|
||||
```
|
||||
|
||||
This function returns true if and only if the JSON value was discarded during parsing with a callback function (see
|
||||
[`parser_callback_t`](parser_callback_t.md)).
|
||||
|
||||
This function returns `#!cpp true` for a JSON value if either:
|
||||
|
||||
- the value was discarded during parsing with a callback function (see [`parser_callback_t`](parser_callback_t.md)), or
|
||||
- the value is the result of parsing invalid JSON with parameter `allow_exceptions` set to `#!cpp false`; see
|
||||
[`parse`](parse.md) for more information.
|
||||
|
||||
## Return value
|
||||
|
||||
`#!cpp true` if type is discarded, `#!cpp false` otherwise.
|
||||
@@ -21,6 +24,30 @@ Constant.
|
||||
|
||||
## Notes
|
||||
|
||||
!!! note
|
||||
|
||||
Discarded values are never compared equal with [`operator==`](operator_eq.md). That is, checking whether a JSON
|
||||
value `j` is discarded will only work via:
|
||||
|
||||
```cpp
|
||||
j.is_discarded()
|
||||
```
|
||||
|
||||
because
|
||||
|
||||
```cpp
|
||||
j == json::value_t::discarded
|
||||
```
|
||||
|
||||
will always be `#!cpp false`.
|
||||
|
||||
!!! note
|
||||
|
||||
When a value is discarded by a callback function (see [`parser_callback_t`](parser_callback_t.md)) during parsing,
|
||||
then it is removed when it is part of a structured value. For instance, if the second value of an array is discared,
|
||||
instead of `#!json [null, discarded, false]`, the array `#!json [null, false]` is returned. Only if the top-level
|
||||
value is discarded, the return value of the `parse` call is discarded.
|
||||
|
||||
This function will always be `#!cpp false` for JSON values after parsing. That is, discarded values can only occur
|
||||
during parsing, but will be removed when inside a structured value or replaced by null in other cases.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user