From 4d81cd10457ec2665a0ee352219c9dbfcc64f108 Mon Sep 17 00:00:00 2001 From: Niels Date: Sat, 11 Apr 2015 18:08:51 +0200 Subject: [PATCH] Created nlohmann::basicjson::begin (markdown) --- nlohmann::basicjson::begin.md | 39 +++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 nlohmann::basicjson::begin.md diff --git a/nlohmann::basicjson::begin.md b/nlohmann::basicjson::begin.md new file mode 100644 index 0000000..8d7c135 --- /dev/null +++ b/nlohmann::basicjson::begin.md @@ -0,0 +1,39 @@ +```cpp +iterator begin(); +const_iterator begin() const; +const_iterator cbegin() const; +``` + +## Description + +Returns an iterator to the first value in the JSON container. If the JSON container is empty, the returned iterator will be equal to `end()`. + +## Parameters + +None. + +## Return value + +Iterator to the first value. Note the return value its deferencabilty depends on the different value types: + +| value type | deferenceable | description | +| ---------- | ------------- | ----------- | +| null | no | `null` has no value, always equal to `end()` | +| boolean | yes | iterator to the boolean value | +| string | yes | iterator to the string value | +| number | yes | iterator to the number value | +| object | only if object is not empty | iterator to the begin of the object | +| array | only if array is not empty | iterator to the begin of the array | + +## Complexity + +Constant, as long as `ArrayType` and `ObjectType` satisfy the [Container concept](http://en.cppreference.com/w/cpp/concept/Container). + +## Exceptions + +None. The function's noexcept-specification is `noexcept`. + +## See also + +- [**end**, **cend**](https://github.com/nlohmann/json/wiki/nlohmann::basicjson::end)
+ returns an iterator to the end