notex::NotexError Class Reference

Base class for every exception raised by the NoTeX core library. More...

#include <notex/errors.hpp>

Inheritance diagram for notex::NotexError:

Public Member Functions
	NotexError (std::string message, ExitCode exit_code)
	Constructs an error with its message and exit code.
ExitCode	exit_code () const noexcept

Detailed Description

Base class for every exception raised by the NoTeX core library.

Carries both a human-readable message, inherited from std::runtime_error, and the ExitCode that the exception should map onto once it reaches the Orchestrator's single catch block.

Definition at line 43 of file errors.hpp.

Constructor & Destructor Documentation

NotexError()

notex::NotexError::NotexError ( std::string message, ExitCode exit_code )

inline

Constructs an error with its message and exit code.

Parameters

message	Human-readable description of what went wrong.
exit_code	Exit code the executable should return.

Definition at line 50 of file errors.hpp.

References exit_code().

Member Function Documentation

exit_code()

ExitCode notex::NotexError::exit_code ( ) const

inlinenoexcept

Returns

The exit code associated with this error.

Definition at line 54 of file errors.hpp.

Referenced by NotexError().

---

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

• notex/include/notex/errors.hpp