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

59 lines
1.3 KiB
Markdown
Raw Normal View History

2020-08-12 14:41:59 +03:00
# basic_json::contains
```cpp
template<typename KeyT>
2021-05-03 21:42:28 +03:00
bool contains(const KeyT& key) const;
2020-08-12 14:41:59 +03:00
```
Check whether an element exists in a JSON object with key equivalent to `key`. If the element is not found or the JSON
value is not an object, `#!cpp false` is returned.
## Template parameters
`KeyT`
: A type for an object key other than `basic_json::json_pointer` 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 to check its existence.
## Return value
`#!cpp true` if an element with specified `key` exists. If no such element with such key is found or the JSON value is
not an object, `#!cpp false` 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 `#!cpp false` when executed on a JSON type that is not an object.
## Example
??? example
The example shows how `contains()` is used.
```cpp
--8<-- "examples/contains.cpp"
```
Output:
```json
--8<-- "examples/contains.output"
```
## Version history
- Added in version 3.6.0.
2021-11-20 15:09:37 +03:00
- Extended template `KeyT` in version 3.10.5 to also support `std::string_view`.