Catch::Option< T > Class Template Reference

#include <catch.hpp>

Public Member Functions
	Option ()
	Option (T const &_value)
	Option (Option const &_other)
	~Option ()
Option &	operator= (Option const &_other)
Option &	operator= (T const &_value)
void	reset ()
T &	operator* ()
T const &	operator* () const
T *	operator-> ()
const T *	operator-> () const
T	valueOr (T const &defaultValue) const
bool	some () const
bool	none () const
bool	operator! () const
	operator SafeBool::type () const

Private Attributes
T *	nullableValue
char	storage [sizeof(T)]

Detailed Description

template<typename T>
class Catch::Option< T >

Definition at line 2730 of file catch.hpp.

Constructor & Destructor Documentation

Option() [1/3]

template<typename T >

Catch::Option< T >::Option ( )

inline

Definition at line 2732 of file catch.hpp.

: nullableValue( CATCH_NULL ) {}

Option() [2/3]

template<typename T >

Catch::Option< T >::Option ( T const &  _value )

inline

Definition at line 2733 of file catch.hpp.

        : nullableValue( new( storage ) T( _value ) )
        {}

Option() [3/3]

template<typename T >

Catch::Option< T >::Option ( Option< T > const &  _other )

inline

Definition at line 2736 of file catch.hpp.

        : nullableValue( _other ? new( storage ) T( *_other ) : CATCH_NULL )
        {}

~Option()

template<typename T >

Catch::Option< T >::~Option ( )

inline

Definition at line 2740 of file catch.hpp.

                  {
            reset();
        }

Member Function Documentation

none()

template<typename T >

bool Catch::Option< T >::none ( ) const

inline

Definition at line 2774 of file catch.hpp.

{ return nullableValue == CATCH_NULL; }

References CATCH_NULL.

operator SafeBool::type()

template<typename T >

Catch::Option< T >::operator SafeBool::type ( ) const

inline

Definition at line 2777 of file catch.hpp.

                                      {
            return SafeBool::makeSafe( some() );
        }

References Catch::SafeBool::makeSafe().

operator!()

template<typename T >

bool Catch::Option< T >::operator! ( ) const

inline

Definition at line 2776 of file catch.hpp.

{ return nullableValue == CATCH_NULL; }

References CATCH_NULL.

operator*() [1/2]

template<typename T >

T& Catch::Option< T >::operator* ( )

inline

Definition at line 2764 of file catch.hpp.

{ return *nullableValue; }

operator*() [2/2]

template<typename T >

T const& Catch::Option< T >::operator* ( ) const

inline

Definition at line 2765 of file catch.hpp.

{ return *nullableValue; }

operator->() [1/2]

template<typename T >

T* Catch::Option< T >::operator-> ( )

inline

Definition at line 2766 of file catch.hpp.

{ return nullableValue; }

operator->() [2/2]

template<typename T >

const T* Catch::Option< T >::operator-> ( ) const

inline

Definition at line 2767 of file catch.hpp.

{ return nullableValue; }

operator=() [1/2]

template<typename T >

Option& Catch::Option< T >::operator= ( Option< T > const &  _other )

inline

Definition at line 2744 of file catch.hpp.

                                                   {
            if( &_other != this ) {
                reset();
                if( _other )
                    nullableValue = new( storage ) T( *_other );
            }
            return *this;
        }

operator=() [2/2]

template<typename T >

Option& Catch::Option< T >::operator= ( T const &  _value )

inline

Definition at line 2752 of file catch.hpp.

                                               {
            reset();
            nullableValue = new( storage ) T( _value );
            return *this;
        }

reset()

template<typename T >

void Catch::Option< T >::reset ( )

inline

Definition at line 2758 of file catch.hpp.

                     {
            if( nullableValue )
                nullableValue->~T();
            nullableValue = CATCH_NULL;
        }

References CATCH_NULL.

some()

template<typename T >

bool Catch::Option< T >::some ( ) const

inline

Definition at line 2773 of file catch.hpp.

{ return nullableValue != CATCH_NULL; }

References CATCH_NULL.

valueOr()

template<typename T >

T Catch::Option< T >::valueOr ( T const &  defaultValue ) const

inline

Definition at line 2769 of file catch.hpp.

                                                 {
            return nullableValue ? *nullableValue : defaultValue;
        }

Field Documentation

nullableValue

template<typename T >

T* Catch::Option< T >::nullableValue

private

Definition at line 2782 of file catch.hpp.

storage

template<typename T >

char Catch::Option< T >::storage[sizeof(T)]

private

Definition at line 2783 of file catch.hpp.

---

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

• src/unittests/catch.hpp (986a3bf)