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

#include <json.hpp>

Public Member Functions
const std::string &	back () const
	return last reference token More...

bool	empty () const noexcept
	return whether pointer points to the root document More...

	json_pointer (const std::string &s="")
	create JSON pointer More...

	operator std::string () const
	return a string representation of the JSON pointer More...

json_pointer &	operator/= (const json_pointer &ptr)
	append another JSON pointer at the end of this JSON pointer More...

json_pointer &	operator/= (std::size_t array_idx)
	append an array index at the end of this JSON pointer More...

json_pointer &	operator/= (std::string token)
	append an unescaped reference token at the end of this JSON pointer More...

json_pointer	parent_pointer () const
	returns the parent of this JSON pointer More...

void	pop_back ()
	remove last reference token More...

void	push_back (const std::string &token)
	append an unescaped token at the end of the reference pointer More...

void	push_back (std::string &&token)
	append an unescaped token at the end of the reference pointer More...

std::string	to_string () const
	return a string representation of the JSON pointer More...

Private Member Functions
JSON_PRIVATE_UNLESS_TESTED JSON pointer has no	BasicJsonType ()))

bool	contains (const BasicJsonType *ptr) const

BasicJsonType &	get_and_create (BasicJsonType &j) const
	create and return a reference to the pointed to value More...

BasicJsonType &	get_checked (BasicJsonType *ptr) const

const BasicJsonType &	get_checked (const BasicJsonType *ptr) const

BasicJsonType &	get_unchecked (BasicJsonType *ptr) const
	return a reference to the pointed to value More...

const BasicJsonType &	get_unchecked (const BasicJsonType *ptr) const
	return a const reference to the pointed to value More...

Static Private Member Functions
static BasicJsonType::size_type	array_index (const std::string &s)

static void	flatten (const std::string &reference_string, const BasicJsonType &value, BasicJsonType &result)

static std::vector< std::string >	split (const std::string &reference_string)
	split the string input to reference tokens More...

static BasicJsonType	unflatten (const BasicJsonType &value)

Private Attributes
JSON_PRIVATE_UNLESS_TESTED	__pad0__: json_pointer top() const { if (JSON_HEDLEY_UNLIKELY(empty())) { JSON_THROW(detail::out_of_range::create(405

JSON_PRIVATE_UNLESS_TESTED JSON pointer has no	parent

result	reference_tokens = {reference_tokens[0]}

std::vector< std::string >	reference_tokens
	the reference tokens More...

json_pointer	result = *this

return	result

Friends
class	basic_json

bool	operator!= (json_pointer const &lhs, json_pointer const &rhs) noexcept
	compares two JSON pointers for inequality More...

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 More...

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 More...

json_pointer	operator/ (const json_pointer &lhs, std::string token)
	create a new JSON pointer by appending the unescaped token at the end of the JSON pointer More...

bool	operator== (json_pointer const &lhs, json_pointer const &rhs) noexcept
	compares two JSON pointers for equality More...

Detailed Description

template<typename BasicJsonType>
class nlohmann::json_pointer< BasicJsonType >

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

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

Definition at line 3331 of file json.hpp.

Constructor & Destructor Documentation

◆ json_pointer()

template<typename BasicJsonType >

nlohmann::json_pointer< BasicJsonType >::json_pointer ( const std::string & s = "" )

inlineexplicit

create JSON pointer

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

Definition at line 12268 of file json.hpp.

Member Function Documentation

◆ array_index()

template<typename BasicJsonType >

static BasicJsonType::size_type nlohmann::json_pointer< BasicJsonType >::array_index ( const std::string & s )

inlinestaticprivate

Parameters

[in] s reference token to be converted into an array index

Returns: integer representation of s

Exceptions

parse_error.106	if an array index begins with '0'
parse_error.109	if an array index begins not with a digit
out_of_range.404	if string s could not be converted to an integer
out_of_range.410	if an array index exceeds size_type

Definition at line 12408 of file json.hpp.

◆ back()

template<typename BasicJsonType >

const std::string& nlohmann::json_pointer< BasicJsonType >::back ( ) const

inline

return last reference token

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

Definition at line 12366 of file json.hpp.

◆ BasicJsonType()

template<typename BasicJsonType >

JSON_PRIVATE_UNLESS_TESTED JSON pointer has no nlohmann::json_pointer< BasicJsonType >::BasicJsonType ( )

private

◆ contains()

template<typename BasicJsonType >

bool nlohmann::json_pointer< BasicJsonType >::contains ( const BasicJsonType * ptr ) const

inlineprivate

Exceptions

parse_error.106	if an array index begins with '0'
parse_error.109	if an array index was not a number

Definition at line 12772 of file json.hpp.

◆ empty()

template<typename BasicJsonType >

bool nlohmann::json_pointer< BasicJsonType >::empty ( ) const

inlinenoexcept

return whether pointer points to the root document

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

Definition at line 12392 of file json.hpp.

◆ flatten()

template<typename BasicJsonType >

static void nlohmann::json_pointer< BasicJsonType >::flatten	(	const std::string &	reference_string,
		const BasicJsonType &	value,
		BasicJsonType &	result
	)

inlinestaticprivate

Parameters

[in]	reference_string	the reference string to the current value
[in]	value	the value to consider
[in,out]	result	the result object to insert values to

Note: Empty objects or arrays are flattened to null.

Definition at line 12928 of file json.hpp.

◆ get_and_create()

template<typename BasicJsonType >

BasicJsonType& nlohmann::json_pointer< BasicJsonType >::get_and_create ( BasicJsonType & j ) const

inlineprivate

create and return a reference to the pointed to value

@complexity Linear in the number of reference tokens.

Exceptions

parse_error.109	if array index is not a number
type_error.313	if value cannot be unflattened

Definition at line 12473 of file json.hpp.

◆ get_checked() [1/2]

template<typename BasicJsonType >

BasicJsonType& nlohmann::json_pointer< BasicJsonType >::get_checked ( BasicJsonType * ptr ) const

inlineprivate

Exceptions

parse_error.106	if an array index begins with '0'
parse_error.109	if an array index was not a number
out_of_range.402	if the array index '-' is used
out_of_range.404	if the JSON pointer can not be resolved

Definition at line 12619 of file json.hpp.

◆ get_checked() [2/2]

template<typename BasicJsonType >

const BasicJsonType& nlohmann::json_pointer< BasicJsonType >::get_checked ( const BasicJsonType * ptr ) const

inlineprivate

Exceptions

parse_error.106	if an array index begins with '0'
parse_error.109	if an array index was not a number
out_of_range.402	if the array index '-' is used
out_of_range.404	if the JSON pointer can not be resolved

Definition at line 12724 of file json.hpp.

◆ get_unchecked() [1/2]

template<typename BasicJsonType >

BasicJsonType& nlohmann::json_pointer< BasicJsonType >::get_unchecked ( BasicJsonType * ptr ) const

inlineprivate

return a reference to the pointed to value

Note: This version does not throw if a value is not present, but tries to create nested values instead. For instance, calling this function with pointer "/this/that" on a null value is equivalent to calling operator[]("this").operator[]("that") on that value, effectively changing the null value to an object.

Parameters

[in] ptr a JSON value

Returns: reference to the JSON value pointed to by the JSON pointer

@complexity Linear in the length of the JSON pointer.

Exceptions

parse_error.106	if an array index begins with '0'
parse_error.109	if an array index was not a number
out_of_range.404	if the JSON pointer can not be resolved

Definition at line 12552 of file json.hpp.

◆ get_unchecked() [2/2]

template<typename BasicJsonType >

const BasicJsonType& nlohmann::json_pointer< BasicJsonType >::get_unchecked ( const BasicJsonType * ptr ) const

inlineprivate

return a const reference to the pointed to value

Parameters

[in] ptr a JSON value

Returns: const reference to the JSON value pointed to by the JSON pointer

Exceptions

parse_error.106	if an array index begins with '0'
parse_error.109	if an array index was not a number
out_of_range.402	if the array index '-' is used
out_of_range.404	if the JSON pointer can not be resolved

Definition at line 12676 of file json.hpp.

◆ operator std::string()

template<typename BasicJsonType >

nlohmann::json_pointer< BasicJsonType >::operator std::string ( ) const

inline

return a string representation of the JSON pointer

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

Definition at line 12286 of file json.hpp.

◆ operator/=() [1/3]

template<typename BasicJsonType >

json_pointer& nlohmann::json_pointer< BasicJsonType >::operator/= ( const json_pointer< BasicJsonType > & ptr )

inline

append another JSON pointer at the end of this JSON pointer

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

Definition at line 12293 of file json.hpp.

◆ operator/=() [2/3]

template<typename BasicJsonType >

json_pointer& nlohmann::json_pointer< BasicJsonType >::operator/= ( std::size_t array_idx )

inline

append an array index at the end of this JSON pointer

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

Definition at line 12311 of file json.hpp.

◆ operator/=() [3/3]

template<typename BasicJsonType >

json_pointer& nlohmann::json_pointer< BasicJsonType >::operator/= ( std::string token )

inline

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

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

Definition at line 12303 of file json.hpp.

◆ parent_pointer()

template<typename BasicJsonType >

json_pointer nlohmann::json_pointer< BasicJsonType >::parent_pointer ( ) const

inline

returns the parent of this JSON pointer

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

Definition at line 12340 of file json.hpp.

◆ pop_back()

template<typename BasicJsonType >

void nlohmann::json_pointer< BasicJsonType >::pop_back ( )

inline

remove last reference token

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

Definition at line 12354 of file json.hpp.

◆ push_back() [1/2]

template<typename BasicJsonType >

void nlohmann::json_pointer< BasicJsonType >::push_back ( const std::string & token )

inline

append an unescaped token at the end of the reference pointer

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

Definition at line 12378 of file json.hpp.

◆ push_back() [2/2]

template<typename BasicJsonType >

void nlohmann::json_pointer< BasicJsonType >::push_back ( std::string && token )

inline

append an unescaped token at the end of the reference pointer

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

Definition at line 12385 of file json.hpp.

◆ split()

template<typename BasicJsonType >

static std::vector<std::string> nlohmann::json_pointer< BasicJsonType >::split ( const std::string & reference_string )

inlinestaticprivate

split the string input to reference tokens

Note: This function is only called by the json_pointer constructor. All exceptions below are documented there.

Exceptions

parse_error.107	if the pointer is not empty or begins with '/'
parse_error.108	if character '~' is not followed by '0' or '1'

Definition at line 12860 of file json.hpp.

◆ to_string()

template<typename BasicJsonType >

std::string nlohmann::json_pointer< BasicJsonType >::to_string ( ) const

inline

return a string representation of the JSON pointer

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

Definition at line 12274 of file json.hpp.

◆ unflatten()

template<typename BasicJsonType >

static BasicJsonType nlohmann::json_pointer< BasicJsonType >::unflatten ( const BasicJsonType & value )

inlinestaticprivate

Parameters

[in] value flattened JSON

Returns: unflattened JSON

Exceptions

parse_error.109	if array index is not a number
type_error.314	if value is not an object
type_error.315	if object values are not primitive
type_error.313	if value cannot be unflattened

Definition at line 12999 of file json.hpp.

Friends And Related Function Documentation

◆ basic_json

template<typename BasicJsonType >

friend class basic_json

friend

Definition at line 12263 of file json.hpp.

◆ operator!=

template<typename BasicJsonType >

bool operator!=	(	json_pointer< BasicJsonType > const &	lhs,
		json_pointer< BasicJsonType > const &	rhs
	)

friend

compares two JSON pointers for inequality

Parameters

[in]	lhs	JSON pointer to compare
[in]	rhs	JSON pointer to compare

Returns: whether lhs is not equal rhs

@complexity Linear in the length of the JSON pointer

@exceptionsafety No-throw guarantee: this function never throws exceptions.

Definition at line 13054 of file json.hpp.

◆ operator/ [1/3]

template<typename BasicJsonType >

json_pointer operator/	(	const json_pointer< BasicJsonType > &	lhs,
		const json_pointer< BasicJsonType > &	rhs
	)

friend

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/

Definition at line 12318 of file json.hpp.

◆ operator/ [2/3]

template<typename BasicJsonType >

json_pointer operator/	(	const json_pointer< BasicJsonType > &	lhs,
		std::size_t	array_idx
	)

friend

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/

Definition at line 12333 of file json.hpp.

◆ operator/ [3/3]

template<typename BasicJsonType >

json_pointer operator/	(	const json_pointer< BasicJsonType > &	lhs,
		std::string	token
	)

friend

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/

Definition at line 12326 of file json.hpp.

◆ operator==

template<typename BasicJsonType >

bool operator==	(	json_pointer< BasicJsonType > const &	lhs,
		json_pointer< BasicJsonType > const &	rhs
	)

friend

compares two JSON pointers for equality

Parameters

[in]	lhs	JSON pointer to compare
[in]	rhs	JSON pointer to compare

Returns: whether lhs is equal to rhs

@complexity Linear in the length of the JSON pointer

@exceptionsafety No-throw guarantee: this function never throws exceptions.

Definition at line 13037 of file json.hpp.

Member Data Documentation

◆ pad0

template<typename BasicJsonType >

JSON_PRIVATE_UNLESS_TESTED nlohmann::json_pointer< BasicJsonType >::__pad0__

private

Definition at line 12456 of file json.hpp.

◆ parent

template<typename BasicJsonType >

JSON_PRIVATE_UNLESS_TESTED JSON pointer has no nlohmann::json_pointer< BasicJsonType >::parent

private

Definition at line 12456 of file json.hpp.

◆ reference_tokens [1/2]

template<typename BasicJsonType >

result nlohmann::json_pointer< BasicJsonType >::reference_tokens = {reference_tokens[0]}

private

Definition at line 12460 of file json.hpp.

◆ reference_tokens [2/2]

template<typename BasicJsonType >

std::vector<std::string> nlohmann::json_pointer< BasicJsonType >::reference_tokens

private

the reference tokens

Definition at line 13061 of file json.hpp.

◆ result [1/2]

template<typename BasicJsonType >

json_pointer nlohmann::json_pointer< BasicJsonType >::result = *this

private

Definition at line 12459 of file json.hpp.

◆ result [2/2]

template<typename BasicJsonType >

return nlohmann::json_pointer< BasicJsonType >::result

private

Definition at line 12461 of file json.hpp.

The documentation for this class was generated from the following file:

json.hpp

Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Friends

Detailed Description

template<typename BasicJsonType> class nlohmann::json_pointer< BasicJsonType >

Constructor & Destructor Documentation

◆ json_pointer()

Member Function Documentation

◆ array_index()

◆ back()

◆ BasicJsonType()

◆ contains()

◆ empty()

◆ flatten()

◆ get_and_create()

◆ get_checked() [1/2]

◆ get_checked() [2/2]

◆ get_unchecked() [1/2]

◆ get_unchecked() [2/2]

◆ operator std::string()

◆ operator/=() [1/3]

◆ operator/=() [2/3]

◆ operator/=() [3/3]

◆ parent_pointer()

◆ pop_back()

◆ push_back() [1/2]

◆ push_back() [2/2]

◆ split()

◆ to_string()

◆ unflatten()

Friends And Related Function Documentation

◆ basic_json

◆ operator!=

◆ operator/ [1/3]

◆ operator/ [2/3]

◆ operator/ [3/3]

◆ operator==

Member Data Documentation

◆ __pad0__

◆ parent

◆ reference_tokens [1/2]

◆ reference_tokens [2/2]

◆ result [1/2]

◆ result [2/2]

template<typename BasicJsonType>
class nlohmann::json_pointer< BasicJsonType >

◆ pad0