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

58 lines
1.2 KiB
Markdown
Raw Normal View History

2020-08-12 14:41:59 +03:00
# basic_json::count
```cpp
template<typename KeyT>
2021-05-03 21:42:28 +03:00
size_type count(const KeyT& key) const;
2020-08-12 14:41:59 +03:00
```
Returns the number of elements with key `key`. If `ObjectType` is the default `std::map` type, the return value will
always be `0` (`key` was not found) or `1` (`key` was found).
## 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 count.
## Return value
Number of elements with key `key`. If the JSON value is not an object, the return value will be `0`.
## 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 `0` when executed on a JSON type that is not an object.
## Example
??? example
The example shows how `count()` is used.
```cpp
--8<-- "examples/count.cpp"
```
Output:
```json
--8<-- "examples/count.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`.