mirror of
https://github.com/nlohmann/json.git
synced 2026-10-12 10:13:13 +00:00
Niels Lohmann
960d3435a1
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>
53 lines
1.2 KiB
Markdown
53 lines
1.2 KiB
Markdown
# <small>nlohmann::basic_json::</small>begin
|
|
|
|
```cpp
|
|
iterator begin() noexcept;
|
|
const_iterator begin() const noexcept;
|
|
```
|
|
|
|
Returns an iterator to the first element.
|
|
|
|
|
|
|
|
## 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](end.md) returns an iterator to one past the last element
|
|
- [cbegin](cbegin.md) returns a const iterator to the first element
|
|
- [rbegin](rbegin.md) returns a reverse iterator to the last element
|
|
- [items](items.md) returns an iteration proxy to access keys and values during range-based for loops
|
|
- [Iterators](../../features/iterators.md) - the article on iterators
|
|
- [basic_json_view::begin](../basic_json_view/begin.md) - the same iteration on a zero-copy view (in document order,
|
|
not sorted by key)
|
|
|
|
## Version history
|
|
|
|
- Added in version 1.0.0.
|