Files
json/docs/mkdocs/docs/api/json_pointer/to_string.md
T
Niels Lohmann 52b72b5684 Improve documentation: byte layouts, release pages, See also, dark-mode images (#5906)
- Make the iterator range illustrations legible in dark mode (prefers-color-scheme
  rules inside the SVGs).
- Add a "Byte layout" section with a color-coded byte table to each binary format
  page (BJData, BON8, BSON, CBOR, MessagePack, UBJSON), and highlight the smallest
  size per file in the comparison table.
- Add "See also" sections to the overview pages that lacked one.
- Split the release notes into one page per release, grouped by minor version on
  the overview page, with an "API changes" section per release generated from the
  API pages' version histories (hooks/api_changes.py).
- Fact-check the release notes and version histories against the release tags and
  correct wrong or misleading entries (e.g., json_serializer 2.1.0, merge_patch
  3.1.0, items, count, operator[], to_bjdata, std::string_view key support).

Signed-off-by: Niels Lohmann <mail@nlohmann.me>
2026-10-24 17:57:44 +02:00

1017 B

nlohmann::json_pointer::to_string

string_t to_string() const;

Return a string representation of the JSON pointer.

Return value

A string representation of the JSON pointer

Exception safety

Strong exception safety: if an exception occurs, the original value stays intact.

Complexity

Linear in the total length of the reference tokens.

Notes

For each JSON pointer ptr, it holds:

ptr == json_pointer(ptr.to_string());

Examples

??? example

The example shows the result of `to_string`.
 
```cpp
--8<-- "examples/json_pointer__to_string.cpp"
```

Output:

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

See also

Version history

  • Added in version 2.0.0.
  • Changed return type to string_t in version 3.11.0.