ignite::ignite_result< T > Class Template Reference

#include <ignite_result.h>

Public Member Functions
	ignite_result (T &&value)
	ignite_result (ignite_error &&error)
bool	has_value () const noexcept
bool	has_error () const noexcept
T &&	value () &&
const T &	value () const &
T &	value () &
ignite_error &&	error () &&
const ignite_error &	error () const &
ignite_error &	error () &
	operator bool () const noexcept

Detailed Description

template<typename T>
class ignite::ignite_result< T >

Ignite Result.

Constructor & Destructor Documentation

ignite_result() [1/2]

template<typename T>

ignite::ignite_result< T >::ignite_result ( T && value )

inline

Constructor.

Parameters

value

Value.

ignite_result() [2/2]

template<typename T>

ignite::ignite_result< T >::ignite_result ( ignite_error && error )

inline

Constructor.

Parameters

error

Error.

Member Function Documentation

error() [1/3]

template<typename T>

ignite_error & ignite::ignite_result< T >::error ( ) &

inlinenodiscard

Get error.

Returns

Error.

error() [2/3]

template<typename T>

ignite_error && ignite::ignite_result< T >::error ( ) &&

inlinenodiscard

Get error.

Returns

Error.

error() [3/3]

template<typename T>

const ignite_error & ignite::ignite_result< T >::error ( ) const &

inlinenodiscard

Get error.

Returns

Error.

has_error()

template<typename T>

bool ignite::ignite_result< T >::has_error ( ) const

inlinenodiscardnoexcept

Has error.

Returns

true if the result has error.

has_value()

template<typename T>

bool ignite::ignite_result< T >::has_value ( ) const

inlinenodiscardnoexcept

Has value.

Returns

true if the result has value.

operator bool()

template<typename T>

ignite::ignite_result< T >::operator bool ( ) const

inlineexplicitnoexcept

Bool operator. Can be used to check the result for an error.

Returns

true if the result does not contain error.

value() [1/3]

template<typename T>

T & ignite::ignite_result< T >::value ( ) &

inlinenodiscard

Get value.

Returns

Value.

value() [2/3]

template<typename T>

T && ignite::ignite_result< T >::value ( ) &&

inlinenodiscard

Get value.

Returns

Value.

value() [3/3]

template<typename T>

const T & ignite::ignite_result< T >::value ( ) const &

inlinenodiscard

Get value.

Returns

Value.

---

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

• ignite/common/ignite_result.h