52 lines
1.4 KiB
Markdown
52 lines
1.4 KiB
Markdown
# nlohmann::json_document
|
|
|
|
Defined in header `<nlohmann/json_view.hpp>`
|
|
|
|
```
|
|
using json_document = basic_json_document<json, view_mode::read_only>;
|
|
```
|
|
|
|
This type is a [`basic_json_document`](https://json.nlohmann.me/api/basic_json_document/index.md) of the default [`json`](https://json.nlohmann.me/api/json/index.md) specialization.
|
|
|
|
## Examples
|
|
|
|
Example
|
|
|
|
The example below demonstrates how to use the type `nlohmann::json_document`.
|
|
|
|
```
|
|
#include <iostream>
|
|
#include <nlohmann/json_view.hpp>
|
|
|
|
using nlohmann::json_document;
|
|
|
|
int main()
|
|
{
|
|
std::cout << std::boolalpha;
|
|
|
|
// json_document is basic_json_document<nlohmann::json>: same value types
|
|
// and containers as the ordinary json specialization
|
|
json_document doc = json_document::parse(R"({"pi": 3.14, "numbers": [1, 2, 3]})");
|
|
|
|
std::cout << doc.root().is_object() << '\n';
|
|
std::cout << doc.root().materialize().dump() << '\n';
|
|
}
|
|
```
|
|
|
|
Output:
|
|
|
|
```
|
|
true
|
|
{"numbers":[1,2,3],"pi":3.14}
|
|
```
|
|
|
|
## See also
|
|
|
|
- [`json_view`](https://json.nlohmann.me/api/json_view/index.md) - a view of a value of a `json_document`
|
|
- [`ordered_json_document`](https://json.nlohmann.me/api/ordered_json_document/index.md) - the corresponding document for `ordered_json`
|
|
- [Zero-copy JSON views](https://json.nlohmann.me/features/json_view/index.md) - how to parse, inspect and edit a document without building a tree
|
|
|
|
## Version history
|
|
|
|
Added in version 3.13.0 unreleased.
|