json/doc/mkdocs/docs/api/basic_json/find.md

62 lines
1.3 KiB
Markdown
Raw Normal View History

2020-08-12 14:41:59 +03:00
# basic_json::find
```cpp
template<typename KeyT>
2021-05-03 21:42:28 +03:00
iterator find(const KeyT& key);
2020-08-12 14:41:59 +03:00
template<typename KeyT>
2021-05-03 21:42:28 +03:00
const_iterator find(const KeyT& key) const
2020-08-12 14:41:59 +03:00
```
Finds an element in a JSON object with key equivalent to `key`. If the element is not found or the JSON value is not an
object, `end()` is returned.
## Template parameters
`KeyT`
: A type for an object key that is less-than comparable with `string_t`. This can also be a string literal or a string
view (C++17).
2020-08-12 14:41:59 +03:00
## Parameters
`key` (in)
: key value of the element to search for.
## Return value
Iterator to an element with key equivalent to `key`. If no such element is found or the JSON value is not an object,
past-the-end (see `end()`) iterator is returned.
## Exception safety
Strong exception safety: if an exception occurs, the original value stays intact.
## Complexity
Logarithmic in the size of the JSON object.
## Notes
This method always returns `end()` when executed on a JSON type that is not an object.
## Example
??? example
The example shows how `find()` is used.
```cpp
--8<-- "examples/find__key_type.cpp"
```
Output:
```json
--8<-- "examples/find__key_type.output"
```
## Version history
- Added in version 1.0.0.
2021-11-20 15:09:37 +03:00
- Extended template `KeyT` in version 3.10.5 to also support `std::string_view`.