amorfo77/json

0 Fork 0

mirror of https://github.com/nlohmann/json.git synced 2026-10-07 15:07:13 +00:00

Files

T

Niels Lohmann 77acd4563c Add element access, iteration, values, and JSON pointers to json_view

Give basic_json_view the read-only access functions of basic_json:
operator[] and at() with keys and indices, front()/back(), find(),
contains(), count(), begin()/end() and cbegin()/cend(), items()
with structured bindings from C++17 on, and type_name().

Exceptions have the ids and messages of the const functions of
basic_json. Where basic_json has undefined behavior the view
answers safely: operator[] with a missing key or an out-of-range
index returns a discarded view, and front()/back() of an empty
container throw invalid_iterator.214. Objects are iterated in
document order, and all members are visited; duplicate-key lookups
find the first member (as yyjson and simdjson do), while parse(),
materialize(), and the map conversions keep the last value, as
parse() does. Keys of up to 16 bytes are compared with two
overlapping loads.

Add value conversions: get<T>()/get_to() for arithmetic types,
bool, nullptr_t, strings (std::basic_string copied,
string_view_t without a copy), BasicJsonType, views, std::vector,
and maps with string keys; get_string() for the string without a
copy; number_token() for the number exactly as written in the
source; value() with keys and JSON pointers; and operator[]/at()/
contains() with JSON pointers. Everything else, including types
with from_json(), goes through materialize() of that subtree.
get<T>() of arithmetic types is inlined down to the conversion, so
reading an integer needs no call.

detail::json_pointer_access exposes a pointer's reference tokens
to code outside basic_json.

Signed-off-by: Niels Lohmann <mail@nlohmann.me>

2026-10-07 16:42:26 +02:00

1.4 KiB

Raw Blame History

nlohmann::basic_json::front

reference front();
const_reference front() const;

Returns a reference to the first element in the container. For a JSON container #!cpp c, the expression #!cpp c.front() is equivalent to #!cpp *c.begin().

Return value

In the case of a structured type (array or object), a reference to the first element is returned. In the case of number, string, boolean, or binary values, a reference to the value is returned.

Exception safety

Strong guarantee: if an exception is thrown, there are no changes in the JSON value.

Exceptions

If the JSON value is #!json null, exception invalid_iterator.214 is thrown.

Complexity

Constant.

Notes

!!! info "Precondition"

The array or object must not be empty. Calling `front` on an empty array or object yields undefined behavior.

Examples

??? example

The following code shows an example for `front()`.
 
```cpp
--8<-- "examples/front.cpp"
```

Output:

```json
--8<-- "examples/front.output"
```

Version history

Added in version 1.0.0.
Adjusted code to return reference to binary values in version 3.8.0.

1.4 KiB Raw Blame History