mirror of https://github.com/nlohmann/json.git synced 2026-06-23 12:44:18 +00:00

Files

T

trdesilva a0a4e7cc0b Add front methods to json_pointers (implements #4889 ) (#5152 )

* Added front, pop_front, and push_front methods to json_pointers in order to facilitate root-to-leaf traversals of JSON object trees. (#4889)

Signed-off-by: trdesilva <5818730+trdesilva@users.noreply.github.com>

* undid VS autoformatting in irrelevant code

Signed-off-by: trdesilva <5818730+trdesilva@users.noreply.github.com>

* Ran make amalgamate, added navigation to json_pointer's new front methods in mkdocs, and fixed errors in documented complexity for those methods.

Signed-off-by: trdesilva <5818730+trdesilva@users.noreply.github.com>

* Fixed GCC 4.8 compile error caused by const iterators

Signed-off-by: trdesilva <5818730+trdesilva@users.noreply.github.com>

* Fixed another gcc-4.8 compile error

Signed-off-by: trdesilva <5818730+trdesilva@users.noreply.github.com>

* amalgamated

Signed-off-by: trdesilva <5818730+trdesilva@users.noreply.github.com>

---------

Signed-off-by: trdesilva <5818730+trdesilva@users.noreply.github.com>

2026-05-13 07:59:16 +02:00

2.3 KiB

Raw Blame History

nlohmann::json_pointer

template<typename RefStringType>
class json_pointer;

A JSON pointer defines a string syntax for identifying a specific value within a JSON document. It can be used with functions at and operator[]. Furthermore, JSON pointers are the base for JSON patches.

Template parameters

RefStringType: the string type used for the reference tokens making up the JSON pointer

!!! warning "Deprecation"

For backwards compatibility `RefStringType` may also be a specialization of [`basic_json`](../basic_json/index.md)
in which case `string_t` will be deduced as [`basic_json::string_t`](../basic_json/string_t.md). This feature is
deprecated and may be removed in a future major version.

Member types

string_t - the string type used for the reference tokens

Member functions

(constructor)
to_string - return a string representation of the JSON pointer
operator string_t - return a string representation of the JSON pointer
operator== - compare: equal
operator!= - compare: not equal
operator/= - append to the end of the JSON pointer
operator/ - create JSON Pointer by appending
parent_pointer - returns the parent of this JSON pointer
pop_back - remove the last reference token
back - return last reference token
push_back - append an unescaped token at the end of the pointer
pop_front - remove the first reference token
front - return first reference token
push_front - append an unescaped token at the start of the pointer
empty - return whether the pointer points to the root document

Literals

operator""_json_pointer - user-defined string literal for JSON pointers

Version history

Added in version 2.0.0.
Changed template parameter from basic_json to string type in version 3.11.0.

2.3 KiB Raw Blame History