error (Error Handling)

Overview

C++ utilities for the error (Error Handling) module.

This module provides two main utilites: Error, which wraps an error code, and Expected, which represents either an error code or a value of configurable type. See the documentation for each of those classes for more details.

Data Structures
class	Error
	A wrapper class for the EtcPal error type. More...
class	BadExpectedAccess
	Exception representing bad access to an Expected instance. More...
class	Expected< T >
	A type representing either a value or an etcpal_error_t code. More...

Error Relational Operators
constexpr bool	operator== (etcpal_error_t code, const Error &error)
constexpr bool	operator!= (etcpal_error_t code, const Error &error)
constexpr bool	operator== (const Error &error, etcpal_error_t code)
constexpr bool	operator!= (const Error &error, etcpal_error_t code)
constexpr bool	operator== (const Error &a, const Error &b)
constexpr bool	operator!= (const Error &a, const Error &b)

Expected Relational Operators
template<typename T1 , typename T2 >
constexpr bool	operator== (const Expected< T1 > &x, const Expected< T2 > &y)
template<typename T1 , typename T2 >
constexpr bool	operator!= (const Expected< T1 > &x, const Expected< T2 > &y)
template<typename T1 , typename T2 >
constexpr bool	operator== (const Expected< T1 > &x, const T2 &v)
template<typename T1 , typename T2 >
constexpr bool	operator== (const T2 &v, const Expected< T1 > &x)
template<typename T1 , typename T2 >
constexpr bool	operator!= (const Expected< T1 > &x, const T2 &v)
template<typename T1 , typename T2 >
constexpr bool	operator!= (const T2 &v, const Expected< T1 > &x)
template<typename T >
constexpr bool	operator== (const Expected< T > &x, etcpal_error_t e)
template<typename T >
constexpr bool	operator== (etcpal_error_t e, const Expected< T > &x)
template<typename T >
constexpr bool	operator!= (const Expected< T > &x, etcpal_error_t e)
template<typename T >
constexpr bool	operator!= (etcpal_error_t e, const Expected< T > &x)