iris::ErrorDetails Struct Reference

Doxygen 1.15.0 generates this reference during each site build from the public headers. The C++ guide shows the API in use.

The parts of an Error besides its code and message, each absent unless the error has it. More...

#include <iris/error.hpp>

Public Attributes
std::optional< Location >	input_location = std::nullopt
	Where in the input the error is, for a read-time error.
std::optional< Location >	spec_location = std::nullopt
	Where in the reader spec the error is: the statement that runs for a read-time error.
std::optional< std::string >	excerpt = std::nullopt
	The input line at the input location without trailing blanks, cut after 100 bytes and then followed by ....
std::optional< std::string >	context = std::nullopt
	The statements that run, outermost first and separated by > , such as repeat [2 of 5] > list clause.
std::optional< std::vector< std::size_t > >	record_path = std::nullopt
	The failed check's witness, outermost index first and counted from 0.
std::optional< std::string >	earlier_rejection = std::nullopt
	The summary of an earlier rejection in the same instance, which may explain this error.
std::optional< std::source_location >	call_site = std::nullopt
	The host code that wrote the statement the error belongs to, for a reader spec from a spec builder (see iris/build.hpp).

Detailed Description

The parts of an Error besides its code and message, each absent unless the error has it.

std::optional<std::source_location> iris::ErrorDetails::call_site = std::nullopt

The host code that wrote the statement the error belongs to, for a reader spec from a spec builder (see iris/build.hpp).

std::optional<std::string> iris::ErrorDetails::context = std::nullopt

The statements that run, outermost first and separated by > , such as repeat [2 of 5] > list clause.

std::optional<std::string> iris::ErrorDetails::earlier_rejection = std::nullopt

The summary of an earlier rejection in the same instance, which may explain this error.

std::optional<std::string> iris::ErrorDetails::excerpt = std::nullopt

The input line at the input location without trailing blanks, cut after 100 bytes and then followed by ....

std::optional<Location> iris::ErrorDetails::input_location = std::nullopt

Where in the input the error is, for a read-time error.

std::optional<std::vector<std::size_t> > iris::ErrorDetails::record_path = std::nullopt

The failed check's witness, outermost index first and counted from 0.

std::optional<Location> iris::ErrorDetails::spec_location = std::nullopt

Where in the reader spec the error is: the statement that runs for a read-time error.