OptionalRef< TElement > Class Template Reference

An optional, modeling a pointer. More...

#include <OptionalRef.hpp>

Collaboration diagram for OptionalRef< TElement >:

Public Types
using	value_type = TElement &

Public Member Functions
	OptionalRef () noexcept
	Construct an invalid (uninitialized) optional.
	OptionalRef (TElement &rElement) noexcept
	Construct an optional reference to the provided instance.
	OptionalRef (OptionalRef &&rRhs) noexcept=default
	OptionalRef (const OptionalRef &rRhs) noexcept=default
OptionalRef &	operator= (OptionalRef &&rRhs) noexcept=default
OptionalRef &	operator= (const OptionalRef &rRhs) noexcept=default
OptionalRef &	operator= (TElement &rElement) noexcept
	Assign the provided instance to the optional.
bool	has_value () const noexcept
	Check whether the optional is valid.
	operator bool () const noexcept
	Check whether the optional is valid.
TElement &	value () const
	Access the stored reference.
TElement &	operator* () const noexcept
	Access the stored reference.
void	reset () noexcept
	Clear the optional.

Detailed Description

template<class TElement>
class Kratos::WRApp::OptionalRef< TElement >

An optional, modeling a pointer.

OptionalRef stores a pointer to the instance it was assigned and stores the value indicator in the least significant bit of the pointer. As a result, the memory alignment of OptionalRef is identical to that of the stored pointer.

Member Typedef Documentation

value_type

template<class TElement >

using value_type = TElement&

Constructor & Destructor Documentation

OptionalRef() [1/4]

template<class TElement >

OptionalRef ( )

inlinenoexcept

Construct an invalid (uninitialized) optional.

OptionalRef() [2/4]

template<class TElement >

OptionalRef ( TElement &  rElement )

inlineexplicitnoexcept

Construct an optional reference to the provided instance.

OptionalRef() [3/4]

template<class TElement >

OptionalRef ( OptionalRef< TElement > &&  rRhs )

defaultnoexcept

OptionalRef() [4/4]

template<class TElement >

OptionalRef ( const OptionalRef< TElement > &  rRhs )

defaultnoexcept

Member Function Documentation

has_value()

template<class TElement >

bool has_value ( ) const

inlinenoexcept

Check whether the optional is valid.

operator bool()

template<class TElement >

operator bool ( ) const

inlineexplicitnoexcept

Check whether the optional is valid.

operator*()

template<class TElement >

TElement & operator* ( ) const

inlinenoexcept

Access the stored reference.

Exceptions

if	the optional is uninitialized.

operator=() [1/3]

template<class TElement >

OptionalRef & operator= ( const OptionalRef< TElement > &  rRhs )

defaultnoexcept

operator=() [2/3]

template<class TElement >

OptionalRef & operator= ( OptionalRef< TElement > &&  rRhs )

defaultnoexcept

operator=() [3/3]

template<class TElement >

OptionalRef & operator= ( TElement &  rElement )

inlinenoexcept

Assign the provided instance to the optional.

reset()

template<class TElement >

void reset ( )

inlinenoexcept

Clear the optional.

value()

template<class TElement >

TElement & value ( ) const

inline

Access the stored reference.

Exceptions

if	the optional is uninitialized.

Member Data Documentation

integer

template<class TElement >

PointerInteger integer

pointer

template<class TElement >

TElement* pointer

---

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

• OptionalRef.hpp