Harsh outcome with a pointer-type outcome. More...

#include <ApparatusStatus.h>

Inheritance diagram for THarshOutcome< PayloadT * >:

Collaboration diagram for THarshOutcome< PayloadT * >:

Public Types
using	PayloadType = PayloadT *
	The payload pointer type.

Public Member Functions
constexpr EApparatusStatus	ToStatus () const
	Convert to a status constant.

constexpr bool	IsNoop () const
	Check if the outcome is a noop.

THarshOutcome &	MapStatus (const EApparatusStatus From, const EApparatusStatus To)
	Map the status from a status to a status.

PayloadType	GetPayload () const
	Get the payload of the outcome.

constexpr	operator EApparatusStatus () const
	Convert to a successful status.

	operator PayloadType () const
	Convert to a payload.

template<typename T >
THarshOutcome< T >	StaticCast ()
	Cast the pointer statically.

template<typename T = PayloadT, more::enable_if_t<!std::is_void< std::decay_t< T > >::value, bool > = true>
THarshOutcome< T & >	Dereference ()
	Dereference.

constexpr bool	IsOK () const
	Convert to successful state for using in a conditional expression.

template<typename T = PayloadT, typename std::enable_if<!std::is_void< T >::value, int >::type = 0>
T *	operator-> () const

template<typename T = PayloadT, typename std::enable_if<!std::is_void< T >::value, int >::type = 0>
T &	operator* () const

bool	operator== (TYPE_OF_NULLPTR) const

bool	operator!= (TYPE_OF_NULLPTR) const

bool	operator== (PayloadT *const Other) const

bool	operator!= (PayloadT *const Other) const

bool	operator! () const

	operator bool () const

THarshOutcome &	operator+= (const THarshOutcome &)

THarshOutcome &	operator+= (const EApparatusStatus InStatus)

THarshOutcome	operator+ (const EApparatusStatus InStatus) const

FString	ToString () const

constexpr	THarshOutcome ()
	Initialize a default harsh outcome with a payload pointer to copy.

template<typename InPayloadT >
	THarshOutcome (InPayloadT &&InPayload)
	Initialize a harsh outcome with a payload pointer to copy.

template<typename InPayloadT >
	THarshOutcome (const EApparatusStatus InStatus, const InPayloadT InPayload)
	Initialize a harsh outcome with a status and a pointer to copy.

	THarshOutcome (const EApparatusStatus InStatus)
	Initialize a harsh outcome with a status and a nullptr.

template<typename InPayloadT >
	THarshOutcome (const TPoliteOutcome< InPayloadT * > &InOutcome)
	Convert from a polite outcome.

template<typename AnyPayloadT , typename InPayloadT >
constexpr	THarshOutcome (const THarshOutcome< AnyPayloadT > &InOutcome, const InPayloadT InPayload)
	Initialize a harsh outcome using a harsh outcome and a payload override.

Static Public Member Functions
static constexpr THarshOutcome< PayloadT * >	Success (TYPE_OF_NULLPTR)
	A constant denoting a successful operation outcome.

static constexpr THarshOutcome< PayloadT * >	Noop (TYPE_OF_NULLPTR)
	A constant denoting a successful skip of any actions.

static constexpr THarshOutcome< PayloadT * >	Success (PayloadT *const InPayload)
	A constant denoting a successful operation outcome.

static constexpr THarshOutcome< PayloadT * >	Noop (PayloadT *const InPayload)
	A constant denoting a successful skip of any actions.

Public Attributes
PayloadT *	Payload
	The payload pointer of the outcome.

Detailed Description

template<typename PayloadT>
struct THarshOutcome< PayloadT * >

Harsh outcome with a pointer-type outcome.

Template Parameters

PayloadT The optional payload object to point.

Member Typedef Documentation

◆ PayloadType

template<typename PayloadT >

using THarshOutcome< PayloadT * >::PayloadType = PayloadT*

The payload pointer type.

Constructor & Destructor Documentation

◆ THarshOutcome() [1/6]

template<typename PayloadT >

constexpr THarshOutcome< PayloadT * >::THarshOutcome ( )

inlineconstexpr

Initialize a default harsh outcome with a payload pointer to copy.

◆ THarshOutcome() [2/6]

template<typename PayloadT >

template<typename InPayloadT >

THarshOutcome< PayloadT * >::THarshOutcome ( InPayloadT && InPayload )

inline

Initialize a harsh outcome with a payload pointer to copy.

Template Parameters

InPayloadT The type of the passed-in payload. Must be assignable to the destination pointer type.

Parameters

InPayload The pointer to copy.

◆ THarshOutcome() [3/6]

template<typename PayloadT >

template<typename InPayloadT >

THarshOutcome< PayloadT * >::THarshOutcome	(	const EApparatusStatus	InStatus,
		const InPayloadT	InPayload
	)

inline

Initialize a harsh outcome with a status and a pointer to copy.

Template Parameters

InPayloadT The type of the passed-in payload. Must be assignable to the destination pointer type.

Parameters

InStatus	The status to initialize with. Must be a successful one.
InPayload	The pointer to copy. Isn't checked for being a `nullptr`.

◆ THarshOutcome() [4/6]

template<typename PayloadT >

THarshOutcome< PayloadT * >::THarshOutcome ( const EApparatusStatus InStatus )

inline

Initialize a harsh outcome with a status and a nullptr.

Parameters

InStatus The status to initialize with. Must be a successful one.

◆ THarshOutcome() [5/6]

template<typename PayloadT >

template<typename InPayloadT >

THarshOutcome< PayloadT * >::THarshOutcome ( const TPoliteOutcome< InPayloadT * > & InOutcome )

inline

Convert from a polite outcome.

Will assert the outcome is a successful one.

Template Parameters

InPayloadT The type of the passed-in payload pointer type.

Parameters

InOutcome The polite outcome to convert from.

◆ THarshOutcome() [6/6]

template<typename PayloadT >

template<typename AnyPayloadT , typename InPayloadT >

constexpr THarshOutcome< PayloadT * >::THarshOutcome	(	const THarshOutcome< AnyPayloadT > &	InOutcome,
		const InPayloadT	InPayload
	)

inlineconstexpr

Initialize a harsh outcome using a harsh outcome and a payload override.

Template Parameters

AnyPayloadT	The type of the payload of the incoming harsh outcome. Used for deduction only.
InPayloadT	The type of the payload to initialize with.

Parameters

InOutcome	The outcome to initialize from. This is basically ignored here.
InPayload	The payload pointer to initialize with.

Member Function Documentation

◆ Dereference()

template<typename PayloadT >

template<typename T = PayloadT, more::enable_if_t<!std::is_void< std::decay_t< T > >::value, bool > = true>

THarshOutcome< T & > THarshOutcome< PayloadT * >::Dereference ( )

inline

Dereference.

◆ GetPayload()

template<typename PayloadT >

PayloadType THarshOutcome< PayloadT * >::GetPayload ( ) const

inline

Get the payload of the outcome.

◆ IsNoop()

template<typename PayloadT >

constexpr bool THarshOutcome< PayloadT * >::IsNoop ( ) const

inlineconstexpr

Check if the outcome is a noop.

◆ IsOK()

template<typename PayloadT >

constexpr bool THarshOutcome< PayloadT * >::IsOK ( ) const

inlineconstexpr

Convert to successful state for using in a conditional expression.

This always return true, since every harsh result is already a success.

Returns: The state of examination.

◆ MapStatus()

template<typename PayloadT >

THarshOutcome & THarshOutcome< PayloadT * >::MapStatus	(	const EApparatusStatus	From,
		const EApparatusStatus	To
	)

inline

Map the status from a status to a status.

Parameters

From	The status to map from.
To	The status to map to.

Returns: Returns itself.

◆ Noop() [1/2]

template<typename PayloadT >

static constexpr THarshOutcome< PayloadT * > THarshOutcome< PayloadT * >::Noop ( PayloadT *const InPayload )

inlinestaticconstexpr

A constant denoting a successful skip of any actions.

◆ Noop() [2/2]

template<typename PayloadT >

static constexpr THarshOutcome< PayloadT * > THarshOutcome< PayloadT * >::Noop ( TYPE_OF_NULLPTR )

inlinestaticconstexpr

A constant denoting a successful skip of any actions.

◆ operator bool()

template<typename PayloadT >

THarshOutcome< PayloadT * >::operator bool ( ) const

inline

◆ operator EApparatusStatus()

template<typename PayloadT >

constexpr THarshOutcome< PayloadT * >::operator EApparatusStatus ( ) const

inlineexplicitconstexpr

Convert to a successful status.

This operation should always be an explicit one for a harsh outcome, since the user should absolutely be aware of what he's actually doing.

◆ operator PayloadType()

template<typename PayloadT >

THarshOutcome< PayloadT * >::operator PayloadType ( ) const

inline

Convert to a payload.

◆ operator!()

template<typename PayloadT >

bool THarshOutcome< PayloadT * >::operator! ( ) const

inline

◆ operator!=() [1/2]

template<typename PayloadT >

bool THarshOutcome< PayloadT * >::operator!= ( PayloadT *const Other ) const

inline

◆ operator!=() [2/2]

template<typename PayloadT >

bool THarshOutcome< PayloadT * >::operator!= ( TYPE_OF_NULLPTR ) const

inline

◆ operator*()

template<typename PayloadT >

template<typename T = PayloadT, typename std::enable_if<!std::is_void< T >::value, int >::type = 0>

T & THarshOutcome< PayloadT * >::operator* ( ) const

inline

◆ operator+()

template<typename PayloadT >

THarshOutcome THarshOutcome< PayloadT * >::operator+ ( const EApparatusStatus InStatus ) const

inline

◆ operator+=() [1/2]

template<typename PayloadT >

THarshOutcome & THarshOutcome< PayloadT * >::operator+= ( const EApparatusStatus InStatus )

inline

◆ operator+=() [2/2]

template<typename PayloadT >

THarshOutcome & THarshOutcome< PayloadT * >::operator+= ( const THarshOutcome< PayloadT * > & )

inline

◆ operator->()

template<typename PayloadT >

template<typename T = PayloadT, typename std::enable_if<!std::is_void< T >::value, int >::type = 0>

T * THarshOutcome< PayloadT * >::operator-> ( ) const

inline

◆ operator==() [1/2]

template<typename PayloadT >

bool THarshOutcome< PayloadT * >::operator== ( PayloadT *const Other ) const

inline

◆ operator==() [2/2]

template<typename PayloadT >

bool THarshOutcome< PayloadT * >::operator== ( TYPE_OF_NULLPTR ) const

inline

◆ StaticCast()

template<typename PayloadT >

template<typename T >

THarshOutcome< T > THarshOutcome< PayloadT * >::StaticCast ( )

inline

Cast the pointer statically.

Template Parameters

The	type of the pointer to cast to.

◆ Success() [1/2]

template<typename PayloadT >

static constexpr THarshOutcome< PayloadT * > THarshOutcome< PayloadT * >::Success ( PayloadT *const InPayload )

inlinestaticconstexpr

A constant denoting a successful operation outcome.

◆ Success() [2/2]

template<typename PayloadT >

static constexpr THarshOutcome< PayloadT * > THarshOutcome< PayloadT * >::Success ( TYPE_OF_NULLPTR )

inlinestaticconstexpr

A constant denoting a successful operation outcome.

◆ ToStatus()

template<typename PayloadT >

constexpr EApparatusStatus THarshOutcome< PayloadT * >::ToStatus ( ) const

inlineconstexpr

Convert to a status constant.

Returns: EApparatusStatus::Success Every harsh outcome is considered to be a success by default.

◆ ToString()

template<typename PayloadT >

FString THarshOutcome< PayloadT * >::ToString ( ) const

inline

Member Data Documentation

◆ Payload

template<typename PayloadT >

PayloadT* THarshOutcome< PayloadT * >::Payload

The payload pointer of the outcome.

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

ApparatusStatus.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Member Typedef Documentation

◆ PayloadType

Constructor & Destructor Documentation

◆ THarshOutcome() [1/6]

◆ THarshOutcome() [2/6]

◆ THarshOutcome() [3/6]

◆ THarshOutcome() [4/6]

◆ THarshOutcome() [5/6]

◆ THarshOutcome() [6/6]

Member Function Documentation

◆ Dereference()

◆ GetPayload()

◆ IsNoop()

◆ IsOK()

◆ MapStatus()

◆ Noop() [1/2]

◆ Noop() [2/2]

◆ operator bool()

◆ operator EApparatusStatus()

◆ operator PayloadType()

◆ operator!()

◆ operator!=() [1/2]

◆ operator!=() [2/2]

◆ operator*()

◆ operator+()

◆ operator+=() [1/2]

◆ operator+=() [2/2]

◆ operator->()

◆ operator==() [1/2]

◆ operator==() [2/2]

◆ StaticCast()

◆ Success() [1/2]

◆ Success() [2/2]

◆ ToStatus()

◆ ToString()

Member Data Documentation

◆ Payload