JSON for Modern C++  2.1.1

◆ at() [4/6]

template<template< typename U, typename V, typename... Args > class ObjectType = std::map, template< typename U, typename... Args > class ArrayType = std::vector, class StringType = std::string, class BooleanType = bool, class NumberIntegerType = std::int64_t, class NumberUnsignedType = std::uint64_t, class NumberFloatType = double, template< typename U > class AllocatorType = std::allocator, template< typename T, typename SFINAE=void > class JSONSerializer = adl_serializer>
const_reference nlohmann::basic_json::at ( const typename object_t::key_type &  key) const
inline

Returns a const reference to the element at with specified key key, with bounds checking.

Parameters
[in]keykey of the element to access
Returns
const reference to the element at key key
Exceptions
type_error.304if the JSON value is not an object; in this case, calling at with a key makes no sense. See example below.
out_of_range.403if the key key is is not stored in the object; that is, find(key) == end(). See example below.
Exception safety
Strong guarantee: if an exception is thrown, there are no changes in the JSON value.
Complexity
Logarithmic in the size of the container.
See also
operator[](const typename object_t::key_type&) for unchecked access by reference
value() for access by value with a default value
Since
version 1.0.0
Example
The example below shows how object elements can be read using at(). It also demonstrates the different exceptions that can be thrown.
1 #include "json.hpp"
2 
3 using json = nlohmann::json;
4 
5 int main()
6 {
7  // create JSON object
8  json object =
9  {
10  {"the good", "il buono"},
11  {"the bad", "il cattivo"},
12  {"the ugly", "il brutto"}
13  };
14 
15  // output element with key "the ugly"
16  std::cout << object.at("the ugly") << '\n';
17 
18 
19  // exception type_error.304
20  try
21  {
22  // use at() on a non-object type
23  const json str = "I am a string";
24  std::cout << str.at("the good") << '\n';
25  }
26  catch (json::type_error& e)
27  {
28  std::cout << e.what() << '\n';
29  }
30 
31  // exception out_of_range.401
32  try
33  {
34  // try to read from a nonexisting key
35  std::cout << object.at("the fast") << '\n';
36  }
37  catch (json::out_of_range)
38  {
39  std::cout << "out of range" << '\n';
40  }
41 }
basic_json<> json
default JSON class
Definition: json.hpp:13933
detail::out_of_range out_of_range
exception indicating access out of the defined range
Definition: json.hpp:1324
detail::type_error type_error
exception indicating executing a member function with a wrong type
Definition: json.hpp:1322
Output (play with this example online):
"il brutto"
[json.exception.type_error.304] cannot use at() with string
out of range
The example code above can be translated with
g++ -std=c++11 -Isrc doc/examples/
at__object_t_key_type_const.cpp -o 
at__object_t_key_type_const 

Definition at line 3937 of file json.hpp.