mirror of https://github.com/nlohmann/json.git synced 2025-05-10 00:53:52 +00:00

* 📝 overwork macro documentation

* 📝 address review comments

* 🔧 add style check to Makefile

* 🙈 overwork .gitignore

* 📌 Pygments 2.12.0 is broken

* ✏️ fix links

* 🚸 adjust output to cppcheck

* 📝 add titles to more admonitions

* ✏️ fix typos

* 📝 document future behavior change

2022-04-25 22:40:45 +02:00

1.9 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

Notes

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

Version history

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

1.9 KiB Raw Blame History