Files
json/docs/mkdocs/docs/api/ordered_json_editable_document.md
Niels Lohmann d04f78864c Document editable json_documents
- API pages for set and push_back of basic_json_document and for the
  editable aliases; the class overviews name the Editable parameter
- type_error.319 on the exceptions page
- the feature page explains editing, and the examples show when it
  helps: a configuration file changed without reformatting it

Signed-off-by: Niels Lohmann <mail@nlohmann.me>
2026-09-30 21:02:05 +02:00

1.8 KiB

nlohmann::ordered_json_editable_document

Defined in header <nlohmann/json_view.hpp>

using ordered_json_editable_document = basic_json_document<ordered_json, true>;

This type is an editable basic_json_document of the ordered_json specialization: set and push_back change values after parsing, as for json_editable_document, and materialize() preserves the document order of object members -- including members set added -- instead of sorting them like json_editable_document does.

Examples

??? example

The example below edits a document with `set`, then shows that `materialize()` keeps the member order of the
source text (with the new member at the end) for `ordered_json_editable_document`, where it would sort the
members alphabetically for [`json_editable_document`](json_editable_document.md).

```cpp
--8<-- "examples/ordered_json_editable_document.cpp"
```

Output:

```json
--8<-- "examples/ordered_json_editable_document.output"
```

See also

Version history

Since version 3.13.0.