nlohmann::json_pointer Class Reference

JSON Pointer. More...

Public Member Functions
	json_pointer (const std::string &s="")
	create JSON pointer More...
std::string	to_string () const noexcept
	return a string representation of the JSON pointer More...
	operator std::string () const
	return a string representation of the JSON pointer More...

Friends
template<template< typename, typename, typename... > class ObjectType, template< typename, typename... > class ArrayType, class StringType , class BooleanType , class NumberIntegerType , class NumberUnsignedType , class NumberFloatType , template< typename > class AllocatorType, template< typename, typename=void > class JSONSerializer>
class	basic_json
	allow basic_json to access private members More...
bool	operator== (json_pointer const &lhs, json_pointer const &rhs) noexcept
bool	operator!= (json_pointer const &lhs, json_pointer const &rhs) noexcept

Detailed Description

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.

See also

RFC 6901

Since

version 2.0.0

Constructor & Destructor Documentation

json_pointer()

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

inlineexplicit

create JSON pointer

Create a JSON pointer according to the syntax described in Section 3 of RFC6901.

Parameters

[in]

s

string representing the JSON pointer; if omitted, the empty string is assumed which references the whole JSON value

Exceptions

parse_error.107	if the given JSON pointer s is nonempty and does not begin with a slash (/); see example below
parse_error.108	if a tilde (~) in the given JSON pointer s is not followed by 0 (representing ~) or 1 (representing /); see example below

{The example shows the construction several valid JSON pointers as well as the exceptional behavior.,json_pointer}

Since

version 2.0.0

Member Function Documentation

to_string()

std::string nlohmann::json_pointer::to_string ( ) const

inlinenoexcept

return a string representation of the JSON pointer

Invariant

For each JSON pointer ptr, it holds:

ptr == json_pointer(ptr.to_string());

Returns

a string representation of the JSON pointer

{The example shows the result of to_string., json_pointer__to_string}

Since

version 2.0.0

References nlohmann::detail::string.

operator std::string()

nlohmann::json_pointer::operator std::string ( ) const

inline

return a string representation of the JSON pointer

Invariant

For each JSON pointer ptr, it holds:

ptr == json_pointer(ptr.to_string());

Returns

a string representation of the JSON pointer

{The example shows the result of to_string., json_pointer__to_string}

Since

version 2.0.0

References nlohmann::detail::parse_error::create(), and nlohmann::detail::string.

Here is the call graph for this function:

Friends And Related Function Documentation

basic_json

template<template< typename, typename, typename... > class ObjectType, template< typename, typename... > class ArrayType, class StringType , class BooleanType , class NumberIntegerType , class NumberUnsignedType , class NumberFloatType , template< typename > class AllocatorType, template< typename, typename=void > class JSONSerializer>

friend class basic_json

friend

allow basic_json to access private members