mirror of
https://github.com/nlohmann/json.git
synced 2026-09-30 14:05:18 +00:00
54455afa40
- API pages for basic_json_document and basic_json_view, one per member, and for the four aliases, each with an example - features/json_view.md: the problem the view solves, ownership and lifetime, what matches basic_json::parse() and what differs, and when to choose json, ordered_json, SAX, or the view - the examples show why one would use the view, not only how: borrowed vs. owned input, reading a few fields and materializing one subtree, reusing a document across many messages - registered in the mkdocs navigation, llms.txt, the docset, the exceptions page (out_of_range.416), architecture.md, the integration page, and the README; the yyjson credit is added to the README and license.md Signed-off-by: Niels Lohmann <mail@nlohmann.me>
1.5 KiB
1.5 KiB
nlohmann::basic_json::is_structured
constexpr bool is_structured() const noexcept;
This function returns #!cpp true if and only if the JSON type is structured (array or object).
Return value
#!cpp true if type is structured (array or object), #!cpp false otherwise.
Exception safety
No-throw guarantee: this member function never throws exceptions.
Complexity
Constant.
Possible implementation
constexpr bool is_structured() const noexcept
{
return is_array() || is_object();
}
Notes
The term structured stems from RFC 8259:
JSON can represent four primitive types (strings, numbers, booleans, and null) and two structured types (objects and arrays).
Note that though strings are containers in C++, they are treated as primitive values in JSON.
Examples
??? example
The following code exemplifies `is_structured()` for all JSON types.
```cpp
--8<-- "examples/is_structured.cpp"
```
Output:
```json
--8<-- "examples/is_structured.output"
```
See also
- is_primitive() returns whether JSON value is primitive
- is_array() returns whether the value is an array
- is_object() returns whether the value is an object
- basic_json_view::is_structured - the same check on a zero-copy view
Version history
- Added in version 1.0.0.