ersa::Error Struct Reference

#include <types.h>

Public Member Functions
constexpr	Error ()=default
constexpr	Error (ErrorCode c, const char *msg="")
constexpr bool	isOk () const
constexpr bool	isError () const

Public Attributes
ErrorCode	code {ErrorCode::Ok}
const char *	message {""}

Detailed Description

Outcome code and optional diagnostic returned by a fallible operation.

Constructor & Destructor Documentation

Error() [1/2]

constexpr ersa::Error::Error ( )

constexprdefault

Construct a successful outcome, which is the default state.

Error() [2/2]

constexpr ersa::Error::Error ( ErrorCode  c, const char *  msg = ""  )

inlineconstexpr

Construct an outcome from a category and optional diagnostic.

Member Function Documentation

isError()

constexpr bool ersa::Error::isError ( ) const

inlineconstexpr

Return true for every non-success category.

isOk()

constexpr bool ersa::Error::isOk ( ) const

inlineconstexpr

Return true only for ErrorCode::Ok.

Member Data Documentation

code

ErrorCode ersa::Error::code {ErrorCode::Ok}

Machine-readable result used for caller branching.

message

const char* ersa::Error::message {""}

Non-owning diagnostic string; implementations should use stable storage.

---

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

• include/ersa/common/types.h