ResultBase< T > Class Template Reference

#include <resultbase.h>

Inheritance diagram for ResultBase< T >:

Detailed Description

template<typename T>
class maxon::ResultBase< T >

Base class for Result.

Public Types
using	ValueType = T

Public Member Functions
	ResultBase ()
	ResultBase (CopyType value)
	ResultBase (MoveType value)
const MAXON_ATTRIBUTE_FORCE_INLINE T &	GetValue () const &
const MAXON_ATTRIBUTE_FORCE_INLINE T &	UncheckedGetValue () const &
	MAXON_MEMBER_ACCESSORS (T, GetValue)
	MAXON_MEMBER_ACCESSORS (T, UncheckedGetValue)
const MAXON_ATTRIBUTE_FORCE_INLINE T &	GetValueAndError (ThreadReferencedError &error) const &
MAXON_ATTRIBUTE_FORCE_INLINE T	GetValueAndError (ThreadReferencedError &error) &&
const MAXON_ATTRIBUTE_FORCE_INLINE T &	GetValueAndError (Error &error) const &
MAXON_ATTRIBUTE_FORCE_INLINE T	GetValueAndError (Error &error) &&
const MAXON_ATTRIBUTE_FORCE_INLINE ThreadReferencedError &	GetErrorStorage () const
MAXON_ATTRIBUTE_FORCE_INLINE ThreadReferencedError &	GetErrorStorage ()

Static Public Attributes
static const Bool	HAS_ERROR

Protected Types
using	CopyType = typename ByValueParam< T >::type
using	MoveType = typename std::conditional< std::is_reference< CopyType >::value, T &&, DummyParamType & >::type
using	DeleteType = const DummyParamType &&
template<typename T2 >
using	ConstructibleFrom = std::enable_if< std::is_constructible< T, T2 >::value >

Protected Attributes
ThreadReferencedError	_error
T	_value

Member Typedef Documentation

ValueType

using ValueType = T

The type of the value of the Result.

CopyType

using CopyType = typename ByValueParam<T>::type

protected

MoveType

using MoveType = typename std::conditional<std::is_reference<CopyType>::value, T&&, DummyParamType&>::type

protected

DeleteType

using DeleteType = const DummyParamType&&

protected

ConstructibleFrom

using ConstructibleFrom = std::enable_if<std::is_constructible<T, T2>::value>

protected

Constructor & Destructor Documentation

ResultBase() [1/3]

ResultBase

(

)

ResultBase() [2/3]

ResultBase ( CopyType  value )

explicit

Constructs a new ResultBase with the given value and no error.

Parameters

[in]

value

Result value.

ResultBase() [3/3]

ResultBase ( MoveType  value )

explicit

Constructs a new ResultBase with the given value and no error.

Parameters

[in]

value

Result value.

Member Function Documentation

GetValue()

const MAXON_ATTRIBUTE_FORCE_INLINE T& GetValue

(

void

)

const &

Returns the result value. A DebugAssert will trigger if this is invoked when there is an error.

Returns

Result value.

UncheckedGetValue()

const MAXON_ATTRIBUTE_FORCE_INLINE T& UncheckedGetValue

(

)

const &

Returns the result value. In case of an error there is no value, then this function returns a null value.

Returns

Result value (or a null value in case of an error).

MAXON_MEMBER_ACCESSORS() [1/2]

MAXON_MEMBER_ACCESSORS	(	T	,
		GetValue
	)

MAXON_MEMBER_ACCESSORS() [2/2]

MAXON_MEMBER_ACCESSORS	(	T	,
		UncheckedGetValue
	)

GetValueAndError() [1/4]

const MAXON_ATTRIBUTE_FORCE_INLINE T& GetValueAndError

(

ThreadReferencedError &

error

)

const &

Returns the result value and error. If there is an error, the parameter #error will be set to the error and a null value is returned.

Parameters

[out]

error

This parameter receives the error (or a nullptr if there is no error).

Returns

Result value (or a null value in case of an error).

GetValueAndError() [2/4]

MAXON_ATTRIBUTE_FORCE_INLINE T GetValueAndError

(

ThreadReferencedError &

error

)

&&

Returns the result value and error. If there is an error, the parameter #error will be set to the error and a null value is returned.

Parameters

[out]

error

This parameter receives the error (or a nullptr if there is no error).

Returns

Result value (or a null value in case of an error).

GetValueAndError() [3/4]

const MAXON_ATTRIBUTE_FORCE_INLINE T& GetValueAndError

(

Error &

error

)

const &

Returns the result value and error. If there is an error, the parameter #error will be set to the error and a null value is returned.

Parameters

[out]

error

This parameter receives the error (or a nullptr if there is no error).

Returns

Result value (or a null value in case of an error).

GetValueAndError() [4/4]

MAXON_ATTRIBUTE_FORCE_INLINE T GetValueAndError

(

Error &

error

)

&&

Returns the result value and error. If there is an error, the parameter #error will be set to the error and a null value is returned.

Parameters

[out]

error

This parameter receives the error (or a nullptr if there is no error).

Returns

Result value (or a null value in case of an error).

GetErrorStorage() [1/2]

const MAXON_ATTRIBUTE_FORCE_INLINE ThreadReferencedError& GetErrorStorage

(

)

const

Returns a reference to the ThreadReferencedError storage in which the Result stores its error.

Returns

The ThreadReferencedError where the error (if any) is stored.

GetErrorStorage() [2/2]

MAXON_ATTRIBUTE_FORCE_INLINE ThreadReferencedError& GetErrorStorage

(

)

Returns a reference to the ThreadReferencedError storage in which the Result stores its error.

Returns

The ThreadReferencedError where the error (if any) is stored.

Member Data Documentation

HAS_ERROR

const Bool HAS_ERROR

static

_error

ThreadReferencedError _error

protected

_value

T _value

protected