Skip to content

# 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

Deprecation

For backwards compatibility `RefStringType` may also be a specialization of `basic_json` in which case `string_t` will be deduced as `basic_json::string_t`. 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/= - 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 last reference token
- back - return last reference token
- push_back - append an unescaped token at the end of the pointer
- empty - return whether pointer points to the root document

## Literals

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

## See also

- RFC 6901

## Version history

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

Last update: July 31, 2022
Back to top