nlohmann::detail::parse_error Class Reference

exception indicating a parse error More...

#include <json.hpp>

Inheritance diagram for nlohmann::detail::parse_error:

Collaboration diagram for nlohmann::detail::parse_error:

Public Member Functions
const char *	what () const noexcept override
	returns the explanatory string

Static Public Member Functions
template<typename BasicJsonType >
static parse_error	create (int id_, const position_t &pos, const std::string &what_arg, const BasicJsonType &context)
	create a parse error exception
template<typename BasicJsonType >
static parse_error	create (int id_, std::size_t byte_, const std::string &what_arg, const BasicJsonType &context)

Data Fields
const std::size_t	byte
	byte index of the parse error
const int	id
	the id of the exception

Static Protected Member Functions
template<typename BasicJsonType >
static std::string	diagnostics (const BasicJsonType &leaf_element)
static std::string	name (const std::string &ename, int id_)

Private Member Functions
	parse_error (int id_, std::size_t byte_, const char *what_arg)

Static Private Member Functions
static std::string	position_string (const position_t &pos)

Private Attributes
std::runtime_error	m
	an exception object as storage for error messages

Detailed Description

exception indicating a parse error

See also

https://json.nlohmann.me/api/basic_json/parse_error/

Definition at line 2900 of file json.hpp.

Constructor & Destructor Documentation

parse_error()

nlohmann::detail::parse_error::parse_error ( int  id_, std::size_t  byte_, const char *  what_arg  )

inlineprivate

Definition at line 2941 of file json.hpp.

Member Function Documentation

create() [1/2]

template<typename BasicJsonType >

static parse_error nlohmann::detail::parse_error::create ( int  id_, const position_t &  pos, const std::string &  what_arg, const BasicJsonType &  context  )

inlinestatic

create a parse error exception

Parameters

[in]	id_	the id of the exception
[in]	pos	the position where the error occurred (or with chars_read_total=0 if the position cannot be determined)
[in]	what_arg	the explanatory string

Returns

parse_error object

Definition at line 2913 of file json.hpp.

References nlohmann::detail::position_t::chars_read_total, nlohmann::detail::exception::diagnostics(), nlohmann::detail::exception::name(), and position_string().

Referenced by nlohmann::json_pointer< BasicJsonType >::array_index(), nlohmann::detail::binary_reader< BasicJsonType, InputAdapterType, SAX >::get_bson_binary(), nlohmann::detail::binary_reader< BasicJsonType, InputAdapterType, SAX >::get_bson_string(), nlohmann::detail::binary_reader< BasicJsonType, InputAdapterType, SAX >::get_cbor_binary(), nlohmann::detail::binary_reader< BasicJsonType, InputAdapterType, SAX >::get_cbor_string(), nlohmann::detail::binary_reader< BasicJsonType, InputAdapterType, SAX >::get_msgpack_string(), nlohmann::detail::binary_reader< BasicJsonType, InputAdapterType, SAX >::get_ubjson_high_precision_number(), nlohmann::detail::binary_reader< BasicJsonType, InputAdapterType, SAX >::get_ubjson_size_type(), nlohmann::detail::binary_reader< BasicJsonType, InputAdapterType, SAX >::get_ubjson_size_value(), nlohmann::detail::binary_reader< BasicJsonType, InputAdapterType, SAX >::get_ubjson_string(), nlohmann::detail::binary_reader< BasicJsonType, InputAdapterType, SAX >::get_ubjson_value(), nlohmann::detail::parser< BasicJsonType, InputAdapterType >::parse(), nlohmann::detail::binary_reader< BasicJsonType, InputAdapterType, SAX >::parse_bson_element_internal(), nlohmann::detail::binary_reader< BasicJsonType, InputAdapterType, SAX >::parse_cbor_internal(), nlohmann::detail::binary_reader< BasicJsonType, InputAdapterType, SAX >::parse_msgpack_internal(), nlohmann::basic_json< ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer, BinaryType >::patch(), nlohmann::detail::binary_reader< BasicJsonType, InputAdapterType, SAX >::sax_parse(), nlohmann::detail::parser< BasicJsonType, InputAdapterType >::sax_parse(), nlohmann::detail::parser< BasicJsonType, InputAdapterType >::sax_parse_internal(), nlohmann::json_pointer< BasicJsonType >::split(), and nlohmann::detail::binary_reader< BasicJsonType, InputAdapterType, SAX >::unexpect_eof().

Here is the caller graph for this function:

create() [2/2]

template<typename BasicJsonType >

static parse_error nlohmann::detail::parse_error::create ( int  id_, std::size_t  byte_, const std::string &  what_arg, const BasicJsonType &  context  )

inlinestatic

Definition at line 2921 of file json.hpp.

References nlohmann::detail::exception::diagnostics(), and nlohmann::detail::exception::name().

diagnostics()

template<typename BasicJsonType >

static std::string nlohmann::detail::exception::diagnostics ( const BasicJsonType &  leaf_element )

inlinestaticprotectedinherited

Definition at line 2830 of file json.hpp.

References nlohmann::detail::array, nlohmann::detail::binary, nlohmann::detail::boolean, nlohmann::detail::discarded, nlohmann::detail::null, nlohmann::detail::number_float, nlohmann::detail::number_integer, nlohmann::detail::number_unsigned, nlohmann::detail::object, and nlohmann::detail::string.

Referenced by create(), nlohmann::detail::invalid_iterator::create(), nlohmann::detail::type_error::create(), nlohmann::detail::out_of_range::create(), nlohmann::detail::other_error::create(), and create().

Here is the caller graph for this function:

name()

static std::string nlohmann::detail::exception::name ( const std::string &  ename, int  id_  )

inlinestaticprotectedinherited

Definition at line 2824 of file json.hpp.

Referenced by create(), nlohmann::detail::invalid_iterator::create(), nlohmann::detail::type_error::create(), nlohmann::detail::out_of_range::create(), nlohmann::detail::other_error::create(), and create().

Here is the caller graph for this function:

position_string()

static std::string nlohmann::detail::parse_error::position_string ( const position_t &  pos )

inlinestaticprivate

Definition at line 2944 of file json.hpp.

References nlohmann::detail::position_t::chars_read_current_line, and nlohmann::detail::position_t::lines_read.

Referenced by create().

Here is the caller graph for this function:

what()

const char * nlohmann::detail::exception::what ( ) const

inlineoverridenoexceptinherited

returns the explanatory string

Definition at line 2812 of file json.hpp.

References nlohmann::detail::exception::m.

Field Documentation

byte

const std::size_t nlohmann::detail::parse_error::byte

byte index of the parse error

The byte index of the last read character in the input file.

Note

For an input with n bytes, 1 is the index of the first character and n+1 is the index of the terminating null byte or the end of file. This also holds true when reading a byte vector (CBOR or MessagePack).

Definition at line 2938 of file json.hpp.

id

const int nlohmann::detail::exception::id

inherited

the id of the exception

Definition at line 2818 of file json.hpp.

m

std::runtime_error nlohmann::detail::exception::m

privateinherited

an exception object as storage for error messages

Definition at line 2895 of file json.hpp.

Referenced by nlohmann::detail::exception::what().

---

The documentation for this class was generated from the following file:

• json.hpp