// (1)
template<class ValueType>
ValueType value(const typename object_t::key_type& key,
ValueType&& default_value) const;
// (2)
template<class ValueType, class KeyType>
ValueType value(KeyType&& key,
ValueType&& default_value) const;
// (3)
template<class ValueType>
ValueType value(const json_pointer& ptr,
const ValueType& default_value) const;-
Returns either a copy of an object's element at the specified key
keyor a given default value if no element with keykeyexists.The function is basically equivalent to executing
try { return at(key); } catch(out_of_range) { return default_value; }
-
See 1. This overload is only available if
KeyTypeis comparable with#!cpp typename object_t::key_typeand#!cpp typename object_comparator_t::is_transparentdenotes a type. -
Returns either a copy of an object's element at the specified JSON pointer
ptror a given default value if no value atptrexists.The function is basically equivalent to executing
try { return at(ptr); } catch(out_of_range) { return default_value; }
!!! note "Differences to at and operator[]"
- Unlike [`at`](at.md), this function does not throw if the given `key`/`ptr` was not found.
- Unlike [`operator[]`](operator[].md), this function does not implicitly add an element to the position defined by
`key`/`ptr` key. This function is furthermore also applicable to const objects.
KeyType
: A type for an object key other than json_pointer that is comparable with
string_t using object_comparator_t.
This can also be a string view (C++17).
ValueType
: type compatible to JSON values, for instance #!cpp int for JSON integer numbers, #!cpp bool for JSON booleans,
or #!cpp std::vector types for JSON arrays. Note the type of the expected value at key/ptr and the default
value default_value must be compatible.
key (in)
: key of the element to access
default_value (in)
: the value to return if key/ptr found no value
ptr (in)
: a JSON pointer to the element to access
- copy of the element at key
keyordefault_valueifkeyis not found - copy of the element at key
keyordefault_valueifkeyis not found - copy of the element at JSON Pointer
ptrordefault_valueif no value forptris found
Strong guarantee: if an exception is thrown, there are no changes to any JSON value.
- The function can throw the following exceptions:
- Throws
type_error.302ifdefault_valuedoes not match the type of the value atkey - Throws
type_error.306if the JSON value is not an object; in that case, usingvalue()with a key makes no sense.
- Throws
- See 1.
- The function can throw the following exceptions:
- Throws
type_error.302ifdefault_valuedoes not match the type of the value atptr - Throws
type_error.306if the JSON value is not an object; in that case, usingvalue()with a key makes no sense.
- Throws
- Logarithmic in the size of the container.
- Logarithmic in the size of the container.
- Logarithmic in the size of the container.
??? example "Example: (1) access specified object element with default value"
The example below shows how object elements can be queried with a default value.
```cpp
--8<-- "examples/value__object_t_key_type.cpp"
```
Output:
```json
--8<-- "examples/value__object_t_key_type.output"
```
??? example "Example: (2) access specified object element using string_view with default value"
The example below shows how object elements can be queried with a default value.
```cpp
--8<-- "examples/value__keytype.c++17.cpp"
```
Output:
```json
--8<-- "examples/value__keytype.c++17.output"
```
??? example "Example: (3) access specified object element via JSON Pointer with default value"
The example below shows how object elements can be queried with a default value.
```cpp
--8<-- "examples/value__json_ptr.cpp"
```
Output:
```json
--8<-- "examples/value__json_ptr.output"
```
- see
atfor access by reference with range checking - see
operator[]for unchecked access by reference
- Added in version 1.0.0. Changed parameter
default_valuetype fromconst ValueType&toValueType&&in version 3.11.0. - Added in version 3.11.0. Made
ValueTypethe first template parameter in version 3.11.2. - Added in version 2.0.2.