json/api/json_document.md

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 of the default json specialization.

Examples

??? example

The example below demonstrates how to use the type `nlohmann::json_document`.

```cpp
#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:

```json
true
{"numbers":[1,2,3],"pi":3.14}

```

See also

• json_view - a view of a value of a json_document
• ordered_json_document - the corresponding document for ordered_json
• Zero-copy JSON views - how to parse, inspect and edit a document without building a tree

Version history

Added in version 3.13.0.