Template Class json_pointer

• Defined in File json.hpp

Nested Relationships

Nested Types

• Template Struct json_pointer::string_t_helper

• Template Struct json_pointer::string_t_helper< NLOHMANN_BASIC_JSON_TPL >

Class Documentation

template<typename RefStringType>
class json_pointer

JSON Pointer defines a string syntax for identifying a specific value within a JSON document.

See also

https://json.nlohmann.me/api/json_pointer/

Public Types

using string_t = typename string_t_helper<RefStringType>::type

Public Functions

inline explicit json_pointer(const string_t &s = "")

create JSON pointer

See also

https://json.nlohmann.me/api/json_pointer/json_pointer/

inline string_t to_string() const

return a string representation of the JSON pointer

See also

https://json.nlohmann.me/api/json_pointer/to_string/

inline operator string_t() const

return a string representation of the JSON pointer

See also

https://json.nlohmann.me/api/json_pointer/operator_string/

inline json_pointer &operator/=(const json_pointer &ptr)

append another JSON pointer at the end of this JSON pointer

See also

https://json.nlohmann.me/api/json_pointer/operator_slasheq/

inline json_pointer &operator/=(string_t token)

append an unescaped reference token at the end of this JSON pointer

See also

https://json.nlohmann.me/api/json_pointer/operator_slasheq/

inline json_pointer &operator/=(std::size_t array_idx)

append an array index at the end of this JSON pointer

See also

https://json.nlohmann.me/api/json_pointer/operator_slasheq/

inline json_pointer parent_pointer() const

returns the parent of this JSON pointer

See also

https://json.nlohmann.me/api/json_pointer/parent_pointer/

inline void pop_back()

remove last reference token

See also

https://json.nlohmann.me/api/json_pointer/pop_back/

inline const string_t &back() const

return last reference token

See also

https://json.nlohmann.me/api/json_pointer/back/

inline void push_back(const string_t &token)

append an unescaped token at the end of the reference pointer

See also

https://json.nlohmann.me/api/json_pointer/push_back/

inline void push_back(string_t &&token)

append an unescaped token at the end of the reference pointer

See also

https://json.nlohmann.me/api/json_pointer/push_back/

inline bool empty() const noexcept

return whether pointer points to the root document

See also

https://json.nlohmann.me/api/json_pointer/empty/

Friends

inline friend std::ostream &operator<<(std::ostream &o, const json_pointer &ptr)

write string representation of the JSON pointer to stream

See also

https://json.nlohmann.me/api/basic_json/operator_ltlt/

inline friend json_pointer operator/(const json_pointer &lhs, const json_pointer &rhs)

create a new JSON pointer by appending the right JSON pointer at the end of the left JSON pointer

See also

https://json.nlohmann.me/api/json_pointer/operator_slash/

inline friend json_pointer operator/(const json_pointer &lhs, string_t token)

create a new JSON pointer by appending the unescaped token at the end of the JSON pointer

See also

https://json.nlohmann.me/api/json_pointer/operator_slash/

inline friend json_pointer operator/(const json_pointer &lhs, std::size_t array_idx)

create a new JSON pointer by appending the array-index-token at the end of the JSON pointer

See also

https://json.nlohmann.me/api/json_pointer/operator_slash/

template<typename RefStringTypeLhs, typename RefStringTypeRhs>
friend bool operator==(const json_pointer<RefStringTypeLhs> &lhs, const json_pointer<RefStringTypeRhs> &rhs) noexcept

compares two JSON pointers for equality

See also

https://json.nlohmann.me/api/json_pointer/operator_eq/

template<typename RefStringTypeLhs, typename StringType>
friend bool operator==(const json_pointer<RefStringTypeLhs> &lhs, const StringType &rhs)

compares JSON pointer and string for equality

See also

https://json.nlohmann.me/api/json_pointer/operator_eq/

template<typename RefStringTypeRhs, typename StringType>
friend bool operator==(const StringType &lhs, const json_pointer<RefStringTypeRhs> &rhs)

compares string and JSON pointer for equality

See also

https://json.nlohmann.me/api/json_pointer/operator_eq/

template<typename RefStringTypeLhs, typename RefStringTypeRhs>
friend bool operator!=(const json_pointer<RefStringTypeLhs> &lhs, const json_pointer<RefStringTypeRhs> &rhs) noexcept

compares two JSON pointers for inequality

See also

https://json.nlohmann.me/api/json_pointer/operator_ne/

template<typename RefStringTypeLhs, typename StringType>
friend bool operator!=(const json_pointer<RefStringTypeLhs> &lhs, const StringType &rhs)

compares JSON pointer and string for inequality

See also

https://json.nlohmann.me/api/json_pointer/operator_ne/

template<typename RefStringTypeRhs, typename StringType>
friend bool operator!=(const StringType &lhs, const json_pointer<RefStringTypeRhs> &rhs)

compares string and JSON pointer for inequality

See also

https://json.nlohmann.me/api/json_pointer/operator_ne/

template<typename RefStringTypeLhs, typename RefStringTypeRhs>
friend bool operator<(const json_pointer<RefStringTypeLhs> &lhs, const json_pointer<RefStringTypeRhs> &rhs) noexcept

compares two JSON pointer for less-than