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

#include <wpi/detail/json_pointer.h>

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

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

◆ 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/

◆ 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/

◆ 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/

◆ 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/

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/

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

wpi/detail/json_pointer.h

Public Types

Public Member Functions

Friends

Detailed Description

Member Typedef Documentation

◆ string_t

Constructor & Destructor Documentation

◆ json_pointer()

Member Function Documentation

◆ back()

◆ empty()

◆ operator string_t()

◆ operator/=() [1/3]

◆ operator/=() [2/3]

◆ operator/=() [3/3]

◆ parent_pointer()

◆ pop_back()

◆ push_back() [1/2]

◆ push_back() [2/2]

◆ to_string()

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]