json/api/basic_json/out_of_range.md

nlohmann::basic_json::out_of_range

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 the case of array indices or nonexisting object keys.

Exceptions have ids 4xx (see list of out-of-range errors).

classDiagram
  direction LR
  
    class std_exception ["std::exception"] {
        <<interface>>
    }

    class json_exception ["basic_json::exception"] {
        +const int id
        +const char* what() const
    }
    
    class json_parse_error ["basic_json::parse_error"] {
        +const std::size_t byte
    }

    class json_invalid_iterator ["basic_json::invalid_iterator"]
    class json_type_error ["basic_json::type_error"]
    class json_out_of_range ["basic_json::out_of_range"]
    class json_other_error ["basic_json::other_error"]

    std_exception <|-- json_exception
    json_exception <|-- json_parse_error
    json_exception <|-- json_invalid_iterator
    json_exception <|-- json_type_error
    json_exception <|-- json_out_of_range
    json_exception <|-- json_other_error

    style json_out_of_range fill:#CCCCFF

Member functions

• what - returns explanatory string

Member variables

• id - the id of the exception

Examples

??? 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"
```

See also

• exception for the base class of all exceptions thrown by the library
• List of out-of-range errors
• parse_error for exceptions indicating a parse error
• invalid_iterator for exceptions indicating errors with iterators
• type_error for exceptions indicating executing a member function with a wrong type
• other_error for exceptions indicating other library errors

Version history

• Since version 3.0.0.