Project
Loading...
Searching...
No Matches
nlohmann::detail::exception Class Reference

general exception of the basic_json class More...

#include <json.h>

Inherits std::exception.

Inherited by nlohmann::detail::invalid_iterator, nlohmann::detail::other_error, nlohmann::detail::out_of_range, nlohmann::detail::parse_error, and nlohmann::detail::type_error.

Public Member Functions

const charwhat () const noexcept override
 returns the explanatory string
 

Public Attributes

const int id
 the id of the exception
 

Protected Member Functions

 exception (int id_, const char *what_arg)
 

Static Protected Member Functions

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

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

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

Since
version 3.0.0

Definition at line 556 of file json.h.

Constructor & Destructor Documentation

◆ exception()

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

Definition at line 569 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 571 of file json.h.

◆ what()

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

returns the explanatory string

Definition at line 560 of file json.h.

Member Data Documentation

◆ id

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

the id of the exception

Definition at line 566 of file json.h.


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