Files
json/docs/mkdocs/docs/api/basic_json/begin.md
T
Niels Lohmann 960d3435a1 Merge branch 'json-view/10-view-document' into json-view/11-view-access
Conflicts in See also lists (docs/mkdocs/docs/api/basic_json/begin.md,docs/mkdocs/docs/api/basic_json/cbegin.md,docs/mkdocs/docs/api/basic_json/cend.md,docs/mkdocs/docs/api/basic_json/end.md,docs/mkdocs/docs/api/basic_json/type_name.md), where develop (#5638) and this branch both edited: kept develop's entries and added this branch's basic_json_view links.

Signed-off-by: Niels Lohmann <mail@nlohmann.me>
2026-10-02 11:37:16 +02:00

1.2 KiB

nlohmann::basic_json::begin

iterator begin() noexcept;
const_iterator begin() const noexcept;

Returns an iterator to the first element.

Illustration from cppreference.com

Return value

iterator to the first element

Exception safety

No-throw guarantee: this member function never throws exceptions.

Complexity

Constant.

Examples

??? example

The following code shows an example for `begin()`.

```cpp
--8<-- "examples/begin.cpp"
```

Output:

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

See also

  • end returns an iterator to one past the last element
  • cbegin returns a const iterator to the first element
  • rbegin returns a reverse iterator to the last element
  • items returns an iteration proxy to access keys and values during range-based for loops
  • Iterators - the article on iterators
  • basic_json_view::begin - the same iteration on a zero-copy view (in document order, not sorted by key)

Version history

  • Added in version 1.0.0.