value::at_pointer

Access an element via JSON Pointer.

Synopsis

value const&
at_pointer(
    string_view ptr,
    boost::source_location const& loc = BOOST_CURRENT_LOCATION) const&; (1)

value&&
at_pointer(
    string_view ptr,
    boost::source_location const& loc = BOOST_CURRENT_LOCATION) &&; (2)

value&
at_pointer(
    string_view ptr,
    boost::source_location const& loc = BOOST_CURRENT_LOCATION) &; (3)

Description

This function is used to access a (potentially nested) element of the value using a JSON Pointer string.

Complexity

Linear in the sizes of ptr and underlying array, object, or string.

Exception Safety

Strong guarantee.

Return Value

reference to the element identified by ptr.

Return Value

reference to the element identified by ptr.

Return Value

reference to the element identified by ptr.

Parameters

Name Description

ptr

JSON Pointer string.

loc

source_location to use in thrown exception; the source location of the call site by default.

Exceptions

Type Thrown On

boost::system::system_error

if an error occurs.

See Also

RFC 6901 - JavaScript Object Notation (JSON) Pointer

Edit this page