general exception of the basic_json class More...

#include "json.h"

Inheritance diagram for nlohmann::detail::exception:

Collaboration diagram for nlohmann::detail::exception:

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

Public Attributes
const int	id
	the id of the exception More...

Protected Member Functions
	exception (int id_, const char *what_arg)

Static Protected Member Functions
static std::string	name (const std::string &ename, int id_)

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

Detailed Description

general exception of the basic_json class

This class is an extension of std::exception objects with a member id for exception ids. It is used as the base class for all exceptions thrown by the basic_json class. This class can hence be used as "wildcard" to catch exceptions.

Subclasses:

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
out_of_range for exceptions indicating access out of the defined range
other_error for exceptions indicating other library errors

Internal:

Note: To have nothrow-copy-constructible exceptions, we internally use std::runtime_error which can cope with arbitrary-length error messages. Intermediate strings are built with static functions and then passed to the actual constructor.

@liveexample{The following code shows how arbitrary library exceptions can be caught.,exception}

Since: version 3.0.0

Definition at line 2419 of file json.h.

Constructor & Destructor Documentation

◆ exception()

nlohmann::detail::exception::exception	(	int	id_,
		const char *	what_arg
	)

inlineprotected

Definition at line 2434 of file json.h.

Member Function Documentation

◆ name()

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

inlinestaticprotected

Definition at line 2436 of file json.h.

References nlohmann::to_string().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ what()

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

inlineoverridenoexcept

returns the explanatory string

Definition at line 2424 of file json.h.

References m.

Member Data Documentation

◆ id

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

the id of the exception

Definition at line 2430 of file json.h.

◆ m

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

private

an exception object as storage for error messages

Definition at line 2443 of file json.h.

Referenced by what().

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

src/applications/utils/json.h

Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Private Attributes