RADCore::RADResult< T > Class Template Reference

Success-or-error return value for APIs that should not throw. More...

#include <RADCore.h>

Public Member Functions
bool	ok () const
	Returns true when a value is present. More...
bool	hasError () const
	Returns true when this result has an error. More...
T &	value ()
	Returns the result value; callers should check ok(). More...
const T &	value () const
	Returns the result value; callers should check ok(). More...
const RADError &	error () const
	Returns the error object. More...
T	valueOr (T defaultValue) const
	Returns value or defaultValue when failed. More...

Static Public Member Functions
static RADResult	success (T value)
	Creates a successful result. More...
static RADResult	failure (RADError error)
	Creates a failed result. More...

Detailed Description

template<typename T>
class RADCore::RADResult< T >

Success-or-error return value for APIs that should not throw.

Member Function Documentation

error()

template<typename T >

const RADError& RADCore::RADResult< T >::error ( ) const

inline

Returns the error object.

failure()

template<typename T >

static RADResult RADCore::RADResult< T >::failure ( RADError  error )

inlinestatic

Creates a failed result.

hasError()

template<typename T >

bool RADCore::RADResult< T >::hasError ( ) const

inline

Returns true when this result has an error.

ok()

template<typename T >

bool RADCore::RADResult< T >::ok ( ) const

inline

Returns true when a value is present.

success()

template<typename T >

static RADResult RADCore::RADResult< T >::success ( T  value )

inlinestatic

Creates a successful result.

value() [1/2]

template<typename T >

T& RADCore::RADResult< T >::value ( )

inline

Returns the result value; callers should check ok().

value() [2/2]

template<typename T >

const T& RADCore::RADResult< T >::value ( ) const

inline

Returns the result value; callers should check ok().

valueOr()

template<typename T >

T RADCore::RADResult< T >::valueOr ( T  defaultValue ) const

inline

Returns value or defaultValue when failed.

---

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

• RADCore/headers/RADCore.h