ersa::Result< T > Class Template Reference

#include <types.h>

Collaboration diagram for ersa::Result< T >:

Public Member Functions
	Result (const T &val)
	Result (T &&val)
	Result (const Error &err)
	Result (ErrorCode code, const char *msg="")
bool	isOk () const
bool	isError () const
const T &	value () const
T &	value ()
const Error &	error () const

Private Attributes
T	value_ {}
Error	error_ {ErrorCode::Ok}

Detailed Description

template<typename T>
class ersa::Result< T >

Value-or-error return type for HAL and service operations.

This keeps hardware and host implementations on one exception-free contract. A successful instance carries a value; a failed instance carries an Error. Callers should inspect isOk() before reading value(), because failed results retain only a default-constructed value for deterministic storage.

Constructor & Destructor Documentation

Result() [1/4]

template<typename T >

ersa::Result< T >::Result ( const T &  val )

inline

Create a successful result by copying val.

Result() [2/4]

template<typename T >

ersa::Result< T >::Result ( T &&  val )

inline

Create a successful result by moving val into the result.

Result() [3/4]

template<typename T >

ersa::Result< T >::Result ( const Error &  err )

inline

Create a failed result from an Error value.

Result() [4/4]

template<typename T >

ersa::Result< T >::Result ( ErrorCode  code, const char *  msg = ""  )

inline

Create a failed result from a code and optional diagnostic.

Member Function Documentation

error()

template<typename T >

const Error & ersa::Result< T >::error ( ) const

inline

Inspect the outcome code and diagnostic for success or failure.

isError()

template<typename T >

bool ersa::Result< T >::isError ( ) const

inline

Test whether the operation completed with an error.

isOk()

template<typename T >

bool ersa::Result< T >::isOk ( ) const

inline

Test whether the operation completed successfully.

value() [1/2]

template<typename T >

T & ersa::Result< T >::value ( )

inline

Mutate the returned value; valid only when isOk() is true.

value() [2/2]

template<typename T >

const T & ersa::Result< T >::value ( ) const

inline

Read the returned value; valid only when isOk() is true.

Member Data Documentation

error_

template<typename T >

Error ersa::Result< T >::error_ {ErrorCode::Ok}

private

value_

template<typename T >

T ersa::Result< T >::value_ {}

private

---

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

• include/ersa/common/types.h