| # <small>nlohmann::basic_json::</small>parse_error | |
| ```cpp | |
| class parse_error : public exception; | |
| ``` | |
| The library throws this exception when a parse error occurs. Parse errors can occur during the deserialization of | |
| JSON text, BJData, BON8, BSON, CBOR, MessagePack, UBJSON, as well as when using JSON Patch. | |
| Member `byte` holds the byte index of the last read character in the input file (see note below). | |
| Exceptions have ids 1xx (see [list of parse errors](../../home/exceptions.md#parse-errors)). | |
| ```mermaid | |
| 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_parse_error fill:#CCCCFF | |
| ``` | |
| ## Member functions | |
| - **what** - returns explanatory string | |
| ## Member variables | |
| - **id** - the id of the exception | |
| - **byte** - byte index of the parse error | |
| ## Notes | |
| For an input with <i>n</i> bytes, 1 is the index of the first character and <i>n</i>+1 is the index of the terminating null byte | |
| or the end of file. This also holds true when reading a byte vector for binary formats. | |
| ## Examples | |
| ??? example | |
| The following code shows how a `parse_error` exception can be caught. | |
| ```cpp | |
| #include <iostream> | |
| #include <nlohmann/json.hpp> | |
| using json = nlohmann::json; | |
| int main() | |
| { | |
| try | |
| { | |
| // parsing input with a syntax error | |
| json j = json::parse("[1,2,3,]"); | |
| } | |
| catch (const json::parse_error& e) | |
| { | |
| // output exception information | |
| std::cout << "message: " << e.what() << '\n' | |
| << "exception id: " << e.id << '\n' | |
| << "byte position of error: " << e.byte << std::endl; | |
| } | |
| } | |
| ``` | |
| Output: | |
| ```json | |
| message: [json.exception.parse_error.101] parse error at line 1, column 8: syntax error while parsing value - unexpected ']'; expected '[', '{', or a literal | |
| exception id: 101 | |
| byte position of error: 8 | |
| ``` | |
| ## See also | |
| - [`exception`](exception.md) for the base class of all exceptions thrown by the library | |
| - [List of parse errors](../../home/exceptions.md#parse-errors) | |
| - [`invalid_iterator`](invalid_iterator.md) for exceptions indicating errors with iterators | |
| - [`type_error`](type_error.md) for exceptions indicating executing a member function with a wrong type | |
| - [`out_of_range`](out_of_range.md) for exceptions indicating access out of the defined range | |
| - [`other_error`](other_error.md) for exceptions indicating other library errors | |
| ## Version history | |
| - Since version 3.0.0. |