forked from Research/WhisperCom
61 lines
1.2 KiB
Markdown
61 lines
1.2 KiB
Markdown
|
# basic_json::out_of_range
|
||
|
|
|
||
|
|
```cpp
|
||
|
|
class out_of_range : public exception;
|
||
|
|
```
|
||
|
|
|
||
|
|
This exception is thrown in case a library function is called on an input parameter that exceeds the expected range, for
|
||
|
|
instance in case of array indices or nonexisting object keys.
|
||
|
|
|
||
|
|
Exceptions have ids 4xx.
|
||
|
|
|
||
|
|
```plantuml
|
||
|
|
std::exception <|-- basic_json::exception
|
||
|
|
basic_json::exception <|-- basic_json::parse_error
|
||
|
|
basic_json::exception <|-- basic_json::invalid_iterator
|
||
|
|
basic_json::exception <|-- basic_json::type_error
|
||
|
|
basic_json::exception <|-- basic_json::out_of_range
|
||
|
|
basic_json::exception <|-- basic_json::other_error
|
||
|
|
|
||
|
|
interface std::exception {}
|
||
|
|
|
||
|
|
class basic_json::exception {
|
||
|
|
+ const int id
|
||
|
|
+ const char* what() const
|
||
|
|
}
|
||
|
|
|
||
|
|
class basic_json::parse_error {
|
||
|
|
+ const std::size_t byte
|
||
|
|
}
|
||
|
|
|
||
|
|
class basic_json::out_of_range #FFFF00 {}
|
||
|
|
```
|
||
|
|
|
||
|
|
## Member functions
|
||
|
|
|
||
|
|
- **what** - returns explanatory string
|
||
|
|
|
||
|
|
## Member variables
|
||
|
|
|
||
|
|
- **id** - the id of the exception
|
||
|
|
|
||
|
|
## Example
|
||
|
|
|
||
|
|
??? example
|
||
|
|
|
||
|
|
The following code shows how a `out_of_range` exception can be caught.
|
||
|
|
|
||
|
|
```cpp
|
||
|
|
--8<-- "examples/out_of_range.cpp"
|
||
|
|
```
|
||
|
|
|
||
|
|
Output:
|
||
|
|
|
||
|
|
```json
|
||
|
|
--8<-- "examples/out_of_range.output"
|
||
|
|
```
|
||
|
|
|
||
|
|
## Version history
|
||
|
|
|
||
|
|
- Since version 3.0.0.
|