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

#include <json.hpp>

Collaboration diagram for json_pointer< RefStringType >:

[legend]

Classes
struct	string_t_helper

struct	string_t_helper< NLOHMANN_BASIC_JSON_TPL >

Public Types
using	string_t = typename string_t_helper<RefStringType>::type

Public Member Functions
	json_pointer (const string_t &s="")
	create JSON pointer

string_t	to_string () const
	return a string representation of the JSON pointer

	operator string_t () const
	return a string representation of the JSON pointer

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

json_pointer &	operator/= (string_t token)
	append an unescaped reference token at the end of this JSON pointer

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

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

void	pop_back ()
	remove last reference token

const string_t &	back () const
	return last reference token

void	push_back (const string_t &token)
	append an unescaped token at the end of the reference pointer

void	push_back (string_t &&token)
	append an unescaped token at the end of the reference pointer

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

Private Member Functions
template<typename BasicJsonType>
BasicJsonType &	get_and_create (BasicJsonType &j) const
	create and return a reference to the pointed to value

template<typename BasicJsonType>
BasicJsonType &	get_unchecked (BasicJsonType *ptr) const
	return a reference to the pointed to value

template<typename BasicJsonType>
BasicJsonType &	get_checked (BasicJsonType *ptr) const

template<typename BasicJsonType>
const BasicJsonType &	get_unchecked (const BasicJsonType *ptr) const
	return a const reference to the pointed to value

template<typename BasicJsonType>
const BasicJsonType &	get_checked (const BasicJsonType *ptr) const

template<typename BasicJsonType>
bool	contains (const BasicJsonType *ptr) const

json_pointer< string_t >	convert () const &

json_pointer< string_t >	convert () &&

Static Private Member Functions
template<typename BasicJsonType>
static BasicJsonType::size_type	array_index (const string_t &s)

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

template<typename BasicJsonType>
static void	flatten (const string_t &reference_string, const BasicJsonType &value, BasicJsonType &result)

template<typename BasicJsonType>
static BasicJsonType	unflatten (const BasicJsonType &value)

Private Attributes
JSON_PRIVATE_UNLESS_TESTED	: 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

JSON_PRIVATE_UNLESS_TESTED JSON pointer has no	nullptr

json_pointer	result = *this

result	reference_tokens = {reference_tokens[0]}

return	result

std::vector< string_t >	reference_tokens
	the reference tokens

Friends
class	basic_json

template<typename>
class	json_pointer

std::ostream &	operator<< (std::ostream &o, const json_pointer &ptr)
	write string representation of the JSON pointer to stream

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

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

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

template<typename RefStringTypeLhs, typename RefStringTypeRhs>
bool	operator== (const json_pointer< RefStringTypeLhs > &lhs, const json_pointer< RefStringTypeRhs > &rhs)
	compares two JSON pointers for equality

template<typename RefStringTypeLhs, typename StringType>
bool	operator== (const json_pointer< RefStringTypeLhs > &lhs, const StringType &rhs)
	compares JSON pointer and string for equality

template<typename RefStringTypeRhs, typename StringType>
bool	operator== (const StringType &lhs, const json_pointer< RefStringTypeRhs > &rhs)
	compares string and JSON pointer for equality

template<typename RefStringTypeLhs, typename RefStringTypeRhs>
bool	operator!= (const json_pointer< RefStringTypeLhs > &lhs, const json_pointer< RefStringTypeRhs > &rhs)
	compares two JSON pointers for inequality

template<typename RefStringTypeLhs, typename StringType>
bool	operator!= (const json_pointer< RefStringTypeLhs > &lhs, const StringType &rhs)
	compares JSON pointer and string for inequality

template<typename RefStringTypeRhs, typename StringType>
bool	operator!= (const StringType &lhs, const json_pointer< RefStringTypeRhs > &rhs)
	compares string and JSON pointer for inequality

template<typename RefStringTypeLhs, typename RefStringTypeRhs>
bool	operator< (const json_pointer< RefStringTypeLhs > &lhs, const json_pointer< RefStringTypeRhs > &rhs)
	compares two JSON pointer for less-than

Detailed Description

template<typename RefStringType>
class json_pointer< RefStringType >

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

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

Member Typedef Documentation

◆ string_t

template<typename RefStringType>

using json_pointer< RefStringType >::string_t = typename string_t_helper<RefStringType>::type

Constructor & Destructor Documentation

◆ json_pointer()

template<typename RefStringType>

json_pointer< RefStringType >::json_pointer ( const string_t & s = "" )

inlineexplicit

create JSON pointer

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

Member Function Documentation

◆ array_index()

template<typename RefStringType>

template<typename BasicJsonType>

static BasicJsonType::size_type json_pointer< RefStringType >::array_index ( const string_t & 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

◆ back()

template<typename RefStringType>

const string_t & json_pointer< RefStringType >::back ( ) const

inline

return last reference token

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

◆ contains()

template<typename RefStringType>

template<typename BasicJsonType>

bool json_pointer< RefStringType >::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

◆ convert() [1/2]

template<typename RefStringType>

json_pointer< string_t > json_pointer< RefStringType >::convert ( ) &&

inlineprivate

◆ convert() [2/2]

template<typename RefStringType>

json_pointer< string_t > json_pointer< RefStringType >::convert ( ) const &

inlineprivate

◆ empty()

template<typename RefStringType>

bool json_pointer< RefStringType >::empty ( ) const

inlinenoexcept

return whether pointer points to the root document

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

◆ flatten()

template<typename RefStringType>

template<typename BasicJsonType>

static void json_pointer< RefStringType >::flatten	(	const string_t &	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.

◆ get_and_create()

template<typename RefStringType>

template<typename BasicJsonType>

BasicJsonType & json_pointer< RefStringType >::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

◆ get_checked() [1/2]

template<typename RefStringType>

template<typename BasicJsonType>

BasicJsonType & json_pointer< RefStringType >::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

◆ get_checked() [2/2]

template<typename RefStringType>

template<typename BasicJsonType>

const BasicJsonType & json_pointer< RefStringType >::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

◆ get_unchecked() [1/2]

template<typename RefStringType>

template<typename BasicJsonType>

BasicJsonType & json_pointer< RefStringType >::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

◆ get_unchecked() [2/2]

template<typename RefStringType>

template<typename BasicJsonType>

const BasicJsonType & json_pointer< RefStringType >::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

◆ operator string_t()

template<typename RefStringType>

json_pointer< RefStringType >::operator string_t ( ) const

inline

return a string representation of the JSON pointer

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

◆ operator/=() [1/3]

template<typename RefStringType>

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

inline

append another JSON pointer at the end of this JSON pointer

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

◆ operator/=() [2/3]

template<typename RefStringType>

json_pointer & json_pointer< RefStringType >::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/

◆ operator/=() [3/3]

template<typename RefStringType>

json_pointer & json_pointer< RefStringType >::operator/= ( string_t 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/

◆ parent_pointer()

template<typename RefStringType>

json_pointer json_pointer< RefStringType >::parent_pointer ( ) const

inline

returns the parent of this JSON pointer

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

◆ pop_back()

template<typename RefStringType>

void json_pointer< RefStringType >::pop_back ( )

inline

remove last reference token

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

◆ push_back() [1/2]

template<typename RefStringType>

void json_pointer< RefStringType >::push_back ( const string_t & token )

inline

append an unescaped token at the end of the reference pointer

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

◆ push_back() [2/2]

template<typename RefStringType>

void json_pointer< RefStringType >::push_back ( string_t && token )

inline

append an unescaped token at the end of the reference pointer

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

◆ split()

template<typename RefStringType>

static std::vector< string_t > json_pointer< RefStringType >::split ( const string_t & 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'

◆ to_string()

template<typename RefStringType>

string_t json_pointer< RefStringType >::to_string ( ) const

inline

return a string representation of the JSON pointer

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

◆ unflatten()

template<typename RefStringType>

template<typename BasicJsonType>

static BasicJsonType json_pointer< RefStringType >::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

Friends And Related Symbol Documentation

◆ basic_json

template<typename RefStringType>

friend class basic_json

friend

◆ json_pointer

template<typename RefStringType>

template<typename>

friend class json_pointer

friend

◆ operator!= [1/3]

template<typename RefStringType>

template<typename RefStringTypeLhs, typename RefStringTypeRhs>

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

friend

compares two JSON pointers for inequality

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

◆ operator!= [2/3]

template<typename RefStringType>

template<typename RefStringTypeLhs, typename StringType>

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

friend

compares JSON pointer and string for inequality

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

◆ operator!= [3/3]

template<typename RefStringType>

template<typename RefStringTypeRhs, typename StringType>

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

friend

compares string and JSON pointer for inequality

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

◆ operator/ [1/3]

template<typename RefStringType>

json_pointer operator/	(	const json_pointer< RefStringType > &	lhs,
		const json_pointer< RefStringType > &	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/

◆ operator/ [2/3]

template<typename RefStringType>

json_pointer operator/	(	const json_pointer< RefStringType > &	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/

◆ operator/ [3/3]

template<typename RefStringType>

json_pointer operator/	(	const json_pointer< RefStringType > &	lhs,
		string_t	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/

◆ operator<

template<typename RefStringType>

template<typename RefStringTypeLhs, typename RefStringTypeRhs>

bool operator<	(	const json_pointer< RefStringTypeLhs > &	lhs,
		const json_pointer< RefStringTypeRhs > &	rhs )

friend

compares two JSON pointer for less-than

◆ operator<<

template<typename RefStringType>

std::ostream & operator<<	(	std::ostream &	o,
		const json_pointer< RefStringType > &	ptr )

friend

write string representation of the JSON pointer to stream

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

◆ operator== [1/3]

template<typename RefStringType>

template<typename RefStringTypeLhs, typename RefStringTypeRhs>

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

friend

compares two JSON pointers for equality

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

◆ operator== [2/3]

template<typename RefStringType>

template<typename RefStringTypeLhs, typename StringType>

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

friend

compares JSON pointer and string for equality

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

◆ operator== [3/3]

template<typename RefStringType>

template<typename RefStringTypeRhs, typename StringType>

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

friend

compares string and JSON pointer for equality

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

Member Data Documentation

◆ pad0

template<typename RefStringType>

JSON_PRIVATE_UNLESS_TESTED json_pointer< RefStringType >::__pad0__

private

◆ nullptr

template<typename RefStringType>

JSON_PRIVATE_UNLESS_TESTED JSON pointer has no json_pointer< RefStringType >::nullptr

private

◆ parent

template<typename RefStringType>

JSON_PRIVATE_UNLESS_TESTED JSON pointer has no json_pointer< RefStringType >::parent

private

◆ reference_tokens [1/2]

template<typename RefStringType>

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

private

◆ reference_tokens [2/2]

template<typename RefStringType>

std::vector<string_t> json_pointer< RefStringType >::reference_tokens

private

the reference tokens

◆ result [1/2]

template<typename RefStringType>

json_pointer json_pointer< RefStringType >::result = *this

private

◆ result [2/2]

template<typename RefStringType>

return json_pointer< RefStringType >::result

private

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

includes/nlohmann/json.hpp

Classes

Public Types

Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ string_t

Constructor & Destructor Documentation

◆ json_pointer()

Member Function Documentation

◆ array_index()

◆ back()

◆ contains()

◆ convert() [1/2]

◆ convert() [2/2]

◆ empty()

◆ flatten()

◆ get_and_create()

◆ get_checked() [1/2]

◆ get_checked() [2/2]

◆ get_unchecked() [1/2]

◆ get_unchecked() [2/2]

◆ operator string_t()

◆ 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 Symbol Documentation

◆ basic_json

◆ json_pointer

◆ operator!= [1/3]

◆ operator!= [2/3]

◆ operator!= [3/3]

◆ operator/ [1/3]

◆ operator/ [2/3]

◆ operator/ [3/3]

◆ operator<

◆ operator<<

◆ operator== [1/3]

◆ operator== [2/3]

◆ operator== [3/3]

Member Data Documentation

◆ __pad0__

◆ nullptr

◆ parent

◆ reference_tokens [1/2]

◆ reference_tokens [2/2]

◆ result [1/2]

◆ result [2/2]

◆ pad0