mirror of
https://github.com/nlohmann/json.git
synced 2026-10-13 01:47:11 +00:00
560 lines
17 KiB
Markdown
560 lines
17 KiB
Markdown
# <small>nlohmann::basic_json::</small>operator[]
|
|
|
|
```cpp
|
|
// (1)
|
|
reference operator[](size_type idx);
|
|
const_reference operator[](size_type idx) const;
|
|
|
|
// (2)
|
|
reference operator[](typename object_t::key_type key);
|
|
const_reference operator[](const typename object_t::key_type& key) const;
|
|
|
|
// (3)
|
|
template<typename KeyType>
|
|
reference operator[](KeyType&& key);
|
|
template<typename KeyType>
|
|
const_reference operator[](KeyType&& key) const;
|
|
|
|
// (4)
|
|
reference operator[](const json_pointer& ptr);
|
|
const_reference operator[](const json_pointer& ptr) const;
|
|
```
|
|
|
|
1. Returns a reference to the array element at specified location `idx`.
|
|
2. Returns a reference to the object element with specified key `key`. The non-const qualified overload takes the key by
|
|
value.
|
|
3. See 2. This overload is only available if `KeyType` is comparable with `#!cpp typename object_t::key_type` and
|
|
`#!cpp typename object_comparator_t::is_transparent` denotes a type.
|
|
4. Returns a reference to the element with specified JSON pointer `ptr`.
|
|
|
|
## Template parameters
|
|
|
|
`KeyType`
|
|
: A type for an object key other than [`json_pointer`](../json_pointer/index.md) that is comparable with
|
|
[`string_t`](string_t.md) using [`object_comparator_t`](object_comparator_t.md).
|
|
This can also be a string view (C++17).
|
|
|
|
## Iterator invalidation
|
|
|
|
For the non-const versions 1. and 4., when passing an **array** index that does not exist, it is created and filled with
|
|
a `#!json null` value before a reference to it is returned. For this, a reallocation can happen, in which case all
|
|
iterators (including the [`end()`](end.md) iterator) and all references to the elements are invalidated.
|
|
|
|
For [`ordered_json`](../ordered_json.md), also passing an **object key** to the non-const versions 2., 3., and 4., a
|
|
reallocation can happen which again invalidates all iterators and all references.
|
|
|
|
## Parameters
|
|
|
|
`idx` (in)
|
|
: index of the element to access
|
|
|
|
`key` (in)
|
|
: object key of the element to access
|
|
|
|
`ptr` (in)
|
|
: JSON pointer to the desired element
|
|
|
|
## Return value
|
|
|
|
1. (const) reference to the element at index `idx`
|
|
2. (const) reference to the element at key `key`
|
|
3. (const) reference to the element at key `key`
|
|
4. (const) reference to the element pointed to by `ptr`
|
|
|
|
## Exception safety
|
|
|
|
Strong exception safety: if an exception occurs, the original value stays intact.
|
|
|
|
## Exceptions
|
|
|
|
1. The function can throw the following exceptions:
|
|
- Throws [`type_error.305`](../../home/exceptions.md#jsonexceptiontype_error305) if the JSON value is not an array
|
|
or null; in that case, using the `[]` operator with an index makes no sense.
|
|
- Throws `#!cpp std::length_error` if `idx` equals the maximum value of `size_type`; the array is left unchanged.
|
|
(This is the one index for which growing the array to hold it cannot be expressed as a `size_type` size, the same
|
|
way an oversized [`resize`](https://en.cppreference.com/w/cpp/container/vector/resize) throws.)
|
|
2. The function can throw the following exceptions:
|
|
- Throws [`type_error.305`](../../home/exceptions.md#jsonexceptiontype_error305) if the JSON value is not an object
|
|
or null; in that case, using the `[]` operator with a key makes no sense.
|
|
3. See 2.
|
|
4. The function can throw the following exceptions:
|
|
- Throws [`parse_error.106`](../../home/exceptions.md#jsonexceptionparse_error106) if an array index in the passed
|
|
JSON pointer `ptr` begins with '0'.
|
|
- Throws [`parse_error.109`](../../home/exceptions.md#jsonexceptionparse_error109) if an array index in the passed
|
|
JSON pointer `ptr` is not a number.
|
|
- Throws [`out_of_range.402`](../../home/exceptions.md#jsonexceptionout_of_range402) if the array index '-' is used
|
|
in the passed JSON pointer `ptr` for the const version.
|
|
- Throws [`out_of_range.404`](../../home/exceptions.md#jsonexceptionout_of_range404) if the JSON pointer `ptr` can
|
|
not be resolved.
|
|
- Throws [`out_of_range.410`](../../home/exceptions.md#jsonexceptionout_of_range410) if an array index in the passed
|
|
JSON pointer `ptr` exceeds the range of `size_type` (e.g., on 32-bit platforms).
|
|
|
|
For the **const** version, an object key or array index in `ptr` that does not exist is not reported by an
|
|
exception, but is undefined behavior (see the notes below). Use [`at`](at.md) for checked access.
|
|
|
|
## Complexity
|
|
|
|
1. Constant if `idx` is in the range of the array. Otherwise, linear in `idx - size()`.
|
|
2. Logarithmic in the size of the container.
|
|
3. Logarithmic in the size of the container.
|
|
4. Logarithmic in the size of the container.
|
|
|
|
## Notes
|
|
|
|
!!! danger "Undefined behavior and runtime assertions"
|
|
|
|
The following cases apply to the **const** overloads; the non-const overloads instead insert the missing element
|
|
(see the notes below).
|
|
|
|
1. If the element at index `idx` does not exist, the behavior is undefined and is **guarded by a
|
|
[runtime assertion](../../features/assertions.md)**!
|
|
2. If the element with key `key` does not exist, the behavior is undefined and is **guarded by a
|
|
[runtime assertion](../../features/assertions.md)**!
|
|
3. If the JSON pointer `ptr` refers to an object key or an array index that does not exist, the behavior is
|
|
undefined and is **guarded by a [runtime assertion](../../features/assertions.md)**!
|
|
|
|
1. The non-const version may add values: If `idx` is beyond the range of the array (i.e., `idx >= size()`), then the
|
|
array is silently filled up with `#!json null` values to make `idx` a valid reference to the last stored element. In
|
|
case the value was `#!json null` before, it is converted to an array.
|
|
|
|
2. If `key` is not found in the object, then it is silently added to the object and filled with a `#!json null` value to
|
|
make `key` a valid reference. In case the value was `#!json null` before, it is converted to an object.
|
|
|
|
3. See 2.
|
|
|
|
4. `null` values are created in arrays and objects if necessary.
|
|
|
|
In particular:
|
|
|
|
- If the JSON pointer points to an object key that does not exist, it is created and filled with a `#!json null`
|
|
value before a reference to it is returned.
|
|
- If the JSON pointer points to an array index that does not exist, it is created and filled with a `#!json null`
|
|
value before a reference to it is returned. All indices between the current maximum and the given index are also
|
|
filled with `#!json null`.
|
|
- The special value `-` is treated as a synonym for the index past the end.
|
|
|
|
!!! note "Creating intermediate levels that don't exist yet"
|
|
|
|
When the JSON pointer traverses intermediate levels that don't exist at all yet (not just a missing
|
|
leaf), each missing level is created as an array or an object depending on whether the corresponding
|
|
pointer token parses as a non-negative integer: a numeric token creates an array, a non-numeric token
|
|
creates an object. For example, on an initially `#!json null` value, `/foo/0/0/0` creates nested arrays,
|
|
while `/foo/one/one/one` creates nested objects. This is not specified by the JSON Pointer RFC; it is
|
|
this library's own, intentional disambiguation rule. See also [JSON Pointer](../../features/json_pointer.md).
|
|
|
|
!!! warning "Deprecation"
|
|
|
|
Overload (4) also accepts a [`json_pointer`](../json_pointer/index.md) whose template argument is a `basic_json`
|
|
specialization (e.g., `nlohmann::json_pointer<nlohmann::json>`) instead of a string type. This is deprecated since
|
|
version 3.11.0 and will be removed in a future major version; use `basic_json::json_pointer` (for `json`,
|
|
`nlohmann::json_pointer<std::string>`) instead.
|
|
|
|
You should be warned by your compiler with a `-Wdeprecated-declarations` warning if you are using a deprecated
|
|
function.
|
|
|
|
See the [migration guide](../../integration/migration_guide.md#json-pointers) for how to update existing code.
|
|
|
|
## Examples
|
|
|
|
??? example "Example: (1) access specified array element"
|
|
|
|
The example below shows how array elements can be read and written using `[]` operator. Note the addition of
|
|
`#!json null` values.
|
|
|
|
```cpp
|
|
#include <iostream>
|
|
#include <nlohmann/json.hpp>
|
|
|
|
using json = nlohmann::json;
|
|
|
|
int main()
|
|
{
|
|
// create a JSON array
|
|
json array = {1, 2, 3, 4, 5};
|
|
|
|
// output element at index 3 (fourth element)
|
|
std::cout << array[3] << '\n';
|
|
|
|
// change last element to 6
|
|
array[array.size() - 1] = 6;
|
|
|
|
// output changed array
|
|
std::cout << array << '\n';
|
|
|
|
// write beyond array limit
|
|
array[10] = 11;
|
|
|
|
// output changed array
|
|
std::cout << array << '\n';
|
|
}
|
|
|
|
```
|
|
|
|
Output:
|
|
|
|
```json
|
|
4
|
|
[1,2,3,4,6]
|
|
[1,2,3,4,6,null,null,null,null,null,11]
|
|
|
|
```
|
|
|
|
??? example "Example: (1) access specified array element (const)"
|
|
|
|
The example below shows how array elements can be read using the `[]` operator.
|
|
|
|
```cpp
|
|
#include <iostream>
|
|
#include <nlohmann/json.hpp>
|
|
|
|
using json = nlohmann::json;
|
|
|
|
int main()
|
|
{
|
|
// create JSON array
|
|
const json array = {"first", "2nd", "third", "fourth"};
|
|
|
|
// output element at index 2 (third element)
|
|
std::cout << array.at(2) << '\n';
|
|
}
|
|
|
|
```
|
|
|
|
Output:
|
|
|
|
```json
|
|
"third"
|
|
|
|
```
|
|
|
|
??? example "Example: (2) access specified object element"
|
|
|
|
The example below shows how object elements can be read and written using the `[]` operator.
|
|
|
|
```cpp
|
|
#include <iostream>
|
|
#include <iomanip>
|
|
#include <nlohmann/json.hpp>
|
|
|
|
using json = nlohmann::json;
|
|
|
|
int main()
|
|
{
|
|
// create a JSON object
|
|
json object =
|
|
{
|
|
{"one", 1}, {"two", 2}, {"three", 2.9}
|
|
};
|
|
|
|
// output element with key "two"
|
|
std::cout << object["two"] << "\n\n";
|
|
|
|
// change element with key "three"
|
|
object["three"] = 3;
|
|
|
|
// output changed array
|
|
std::cout << std::setw(4) << object << "\n\n";
|
|
|
|
// mention nonexisting key
|
|
object["four"];
|
|
|
|
// write to nonexisting key
|
|
object["five"]["really"]["nested"] = true;
|
|
|
|
// output changed object
|
|
std::cout << std::setw(4) << object << '\n';
|
|
}
|
|
|
|
```
|
|
|
|
Output:
|
|
|
|
```json
|
|
2
|
|
|
|
{
|
|
"one": 1,
|
|
"three": 3,
|
|
"two": 2
|
|
}
|
|
|
|
{
|
|
"five": {
|
|
"really": {
|
|
"nested": true
|
|
}
|
|
},
|
|
"four": null,
|
|
"one": 1,
|
|
"three": 3,
|
|
"two": 2
|
|
}
|
|
|
|
```
|
|
|
|
??? example "Example: (2) access specified object element (const)"
|
|
|
|
The example below shows how object elements can be read using the `[]` operator.
|
|
|
|
```cpp
|
|
#include <iostream>
|
|
#include <nlohmann/json.hpp>
|
|
|
|
using json = nlohmann::json;
|
|
|
|
int main()
|
|
{
|
|
// create a JSON object
|
|
const json object =
|
|
{
|
|
{"one", 1}, {"two", 2}, {"three", 2.9}
|
|
};
|
|
|
|
// output element with key "two"
|
|
std::cout << object["two"] << '\n';
|
|
}
|
|
|
|
```
|
|
|
|
Output:
|
|
|
|
```json
|
|
2
|
|
|
|
```
|
|
|
|
??? example "Example: (3) access specified object element using string_view"
|
|
|
|
The example below shows how object elements can be read using the `[]` operator.
|
|
|
|
```cpp
|
|
#include <iostream>
|
|
#include <iomanip>
|
|
#include <string_view>
|
|
#include <nlohmann/json.hpp>
|
|
|
|
using namespace std::string_view_literals;
|
|
using json = nlohmann::json;
|
|
|
|
int main()
|
|
{
|
|
// create a JSON object
|
|
json object =
|
|
{
|
|
{"one", 1}, {"two", 2}, {"three", 2.9}
|
|
};
|
|
|
|
// output element with key "two"
|
|
std::cout << object["two"sv] << "\n\n";
|
|
|
|
// change element with key "three"
|
|
object["three"sv] = 3;
|
|
|
|
// output changed array
|
|
std::cout << std::setw(4) << object << "\n\n";
|
|
|
|
// mention nonexisting key
|
|
object["four"sv];
|
|
|
|
// write to nonexisting key
|
|
object["five"sv]["really"sv]["nested"sv] = true;
|
|
|
|
// output changed object
|
|
std::cout << std::setw(4) << object << '\n';
|
|
}
|
|
|
|
```
|
|
|
|
Output:
|
|
|
|
```json
|
|
2
|
|
|
|
{
|
|
"one": 1,
|
|
"three": 3,
|
|
"two": 2
|
|
}
|
|
|
|
{
|
|
"five": {
|
|
"really": {
|
|
"nested": true
|
|
}
|
|
},
|
|
"four": null,
|
|
"one": 1,
|
|
"three": 3,
|
|
"two": 2
|
|
}
|
|
|
|
```
|
|
|
|
??? example "Example: (3) access specified object element using string_view (const)"
|
|
|
|
The example below shows how object elements can be read using the `[]` operator.
|
|
|
|
```cpp
|
|
#include <iostream>
|
|
#include <string_view>
|
|
#include <nlohmann/json.hpp>
|
|
|
|
using namespace std::string_view_literals;
|
|
using json = nlohmann::json;
|
|
|
|
int main()
|
|
{
|
|
// create a JSON object
|
|
const json object =
|
|
{
|
|
{"one", 1}, {"two", 2}, {"three", 2.9}
|
|
};
|
|
|
|
// output element with key "two"
|
|
std::cout << object["two"sv] << '\n';
|
|
}
|
|
|
|
```
|
|
|
|
Output:
|
|
|
|
```json
|
|
2
|
|
|
|
```
|
|
|
|
??? example "Example: (4) access specified element via JSON Pointer"
|
|
|
|
The example below shows how values can be read and written using JSON Pointers.
|
|
|
|
```cpp
|
|
#include <iostream>
|
|
#include <nlohmann/json.hpp>
|
|
|
|
using json = nlohmann::json;
|
|
using namespace nlohmann::literals;
|
|
|
|
int main()
|
|
{
|
|
// create a JSON value
|
|
json j =
|
|
{
|
|
{"number", 1}, {"string", "foo"}, {"array", {1, 2}}
|
|
};
|
|
|
|
// read-only access
|
|
|
|
// output element with JSON pointer "/number"
|
|
std::cout << j["/number"_json_pointer] << '\n';
|
|
// output element with JSON pointer "/string"
|
|
std::cout << j["/string"_json_pointer] << '\n';
|
|
// output element with JSON pointer "/array"
|
|
std::cout << j["/array"_json_pointer] << '\n';
|
|
// output element with JSON pointer "/array/1"
|
|
std::cout << j["/array/1"_json_pointer] << '\n';
|
|
|
|
// writing access
|
|
|
|
// change the string
|
|
j["/string"_json_pointer] = "bar";
|
|
// output the changed string
|
|
std::cout << j["string"] << '\n';
|
|
|
|
// "change" a nonexisting object entry
|
|
j["/boolean"_json_pointer] = true;
|
|
// output the changed object
|
|
std::cout << j << '\n';
|
|
|
|
// change an array element
|
|
j["/array/1"_json_pointer] = 21;
|
|
// "change" an array element with nonexisting index
|
|
j["/array/4"_json_pointer] = 44;
|
|
// output the changed array
|
|
std::cout << j["array"] << '\n';
|
|
|
|
// "change" the array element past the end
|
|
j["/array/-"_json_pointer] = 55;
|
|
// output the changed array
|
|
std::cout << j["array"] << '\n';
|
|
}
|
|
|
|
```
|
|
|
|
Output:
|
|
|
|
```json
|
|
1
|
|
"foo"
|
|
[1,2]
|
|
2
|
|
"bar"
|
|
{"array":[1,2],"boolean":true,"number":1,"string":"bar"}
|
|
[1,21,null,null,44]
|
|
[1,21,null,null,44,55]
|
|
|
|
```
|
|
|
|
??? example "Example: (4) access specified element via JSON Pointer (const)"
|
|
|
|
The example below shows how values can be read using JSON Pointers.
|
|
|
|
```cpp
|
|
#include <iostream>
|
|
#include <nlohmann/json.hpp>
|
|
|
|
using json = nlohmann::json;
|
|
using namespace nlohmann::literals;
|
|
|
|
int main()
|
|
{
|
|
// create a JSON value
|
|
const json j =
|
|
{
|
|
{"number", 1}, {"string", "foo"}, {"array", {1, 2}}
|
|
};
|
|
|
|
// read-only access
|
|
|
|
// output element with JSON pointer "/number"
|
|
std::cout << j["/number"_json_pointer] << '\n';
|
|
// output element with JSON pointer "/string"
|
|
std::cout << j["/string"_json_pointer] << '\n';
|
|
// output element with JSON pointer "/array"
|
|
std::cout << j["/array"_json_pointer] << '\n';
|
|
// output element with JSON pointer "/array/1"
|
|
std::cout << j["/array/1"_json_pointer] << '\n';
|
|
}
|
|
|
|
```
|
|
|
|
Output:
|
|
|
|
```json
|
|
1
|
|
"foo"
|
|
[1,2]
|
|
2
|
|
|
|
```
|
|
|
|
## See also
|
|
|
|
- documentation on [unchecked access](../../features/element_access/unchecked_access.md)
|
|
- documentation on [runtime assertions](../../features/assertions.md)
|
|
- see [`at`](at.md) for access by reference with range checking
|
|
- see [`value`](value.md) for access with default value
|
|
|
|
## Version history
|
|
|
|
1. Added in version 1.0.0. Fixed in version 3.13.0 to throw `#!cpp std::length_error` instead of emptying the array and
|
|
accessing it out of bounds when `idx` equals the maximum value of `size_type`. A missing index in the const version
|
|
is guarded by a runtime assertion since version 3.13.0.
|
|
2. Added in version 1.0.0. Added overloads for `T* key` in version 1.1.0. Removed overloads for `T* key` (replaced by 3)
|
|
in version 3.11.0.
|
|
3. Added in version 3.11.0. Fixed in version 3.13.0 to consistently accept `std::string_view`-convertible keys, as
|
|
already supported by [`at`](at.md), [`value`](value.md), [`find`](find.md), and other lookup functions.
|
|
4. Added in version 2.0.0. A missing array index in the const version is guarded by a runtime assertion since
|
|
version 3.13.0. Throws [`parse_error.109`](../../home/exceptions.md#jsonexceptionparse_error109) instead of
|
|
[`out_of_range.404`](../../home/exceptions.md#jsonexceptionout_of_range404) for a one-character array index that is not
|
|
a digit (e.g., `/x`) in version 3.13.0, as it already did for longer ones.
|