clara::detail::BasicResult< T > Class Template Reference

#include <clara.hpp>

Inheritance diagram for clara::detail::BasicResult< T >:

Collaboration diagram for clara::detail::BasicResult< T >:

Public Member Functions
template<typename U >
	BasicResult (BasicResult< U > const &other)
	operator bool () const
auto	type () const -> ResultBase::Type
auto	errorMessage () const -> std::string

Static Public Member Functions
template<typename U >
static auto	ok (U const &value) -> BasicResult
static auto	ok () -> BasicResult
static auto	logicError (std::string const &message) -> BasicResult
static auto	runtimeError (std::string const &message) -> BasicResult

Protected Member Functions
void	enforceOk () const override
	BasicResult (ResultBase::Type type, std::string const &message)
Protected Member Functions inherited from clara::detail::ResultValueBase< void >
	ResultBase (Type type)
Protected Member Functions inherited from clara::detail::ResultBase
	ResultBase (Type type)
virtual	~ResultBase ()=default

Protected Attributes
std::string	m_errorMessage
Type	m_type
Protected Attributes inherited from clara::detail::ResultBase
Type	m_type

Additional Inherited Members
Public Types inherited from clara::detail::ResultBase
enum	Type { Ok , LogicError , RuntimeError }

Detailed Description

template<typename T = void>
class clara::detail::BasicResult< T >

Definition at line 581 of file clara.hpp.

Constructor & Destructor Documentation

BasicResult() [1/2]

template<typename T = void>

template<typename U >

clara::detail::BasicResult< T >::BasicResult ( BasicResult< U > const & other )

inlineexplicit

Definition at line 584 of file clara.hpp.

        :   ResultValueBase<T>( other.type() ),
            m_errorMessage( other.errorMessage() )
        {
            assert( type() != ResultBase::Ok );
        }

Here is the call graph for this function:

BasicResult() [2/2]

template<typename T = void>

clara::detail::BasicResult< T >::BasicResult ( ResultBase::Type type, std::string const & message )

inlineprotected

Definition at line 614 of file clara.hpp.

        :   ResultValueBase<T>(type),
            m_errorMessage(message)
        {
            assert( m_type != ResultBase::Ok );
        }

Member Function Documentation

enforceOk()

template<typename T = void>

void clara::detail::BasicResult< T >::enforceOk ( ) const

inlineoverrideprotectedvirtual

Implements clara::detail::ResultBase.

Definition at line 602 of file clara.hpp.

                                        {
 
            // Errors shouldn't reach this point, but if they do
            // the actual error message will be in m_errorMessage
            assert( m_type != ResultBase::LogicError );
            assert( m_type != ResultBase::RuntimeError );
            if( m_type != ResultBase::Ok )
                std::abort();
        }

errorMessage()

template<typename T = void>

auto clara::detail::BasicResult< T >::errorMessage ( ) const -> std::string

inline

Definition at line 599 of file clara.hpp.

{ return m_errorMessage; }

logicError()

template<typename T = void>

static auto clara::detail::BasicResult< T >::logicError ( std::string const & message ) -> BasicResult

inlinestatic

Definition at line 594 of file clara.hpp.

{ return { ResultBase::LogicError, message }; }

Here is the caller graph for this function:

ok() [1/2]

template<typename T = void>

static auto clara::detail::BasicResult< T >::ok ( ) -> BasicResult

inlinestatic

Definition at line 593 of file clara.hpp.

{ return { ResultBase::Ok }; }

Here is the caller graph for this function:

ok() [2/2]

template<typename T = void>

template<typename U >

static auto clara::detail::BasicResult< T >::ok ( U const & value ) -> BasicResult

inlinestatic

Definition at line 592 of file clara.hpp.

{ return { ResultBase::Ok, value }; }

operator bool()

template<typename T = void>

clara::detail::BasicResult< T >::operator bool ( ) const

inlineexplicit

Definition at line 597 of file clara.hpp.

{ return m_type == ResultBase::Ok; }

runtimeError()

template<typename T = void>

static auto clara::detail::BasicResult< T >::runtimeError ( std::string const & message ) -> BasicResult

inlinestatic

Definition at line 595 of file clara.hpp.

{ return { ResultBase::RuntimeError, message }; }

Here is the caller graph for this function:

type()

template<typename T = void>

auto clara::detail::BasicResult< T >::type ( ) const -> ResultBase::Type

inline

Definition at line 598 of file clara.hpp.

{ return m_type; }

Here is the caller graph for this function:

Member Data Documentation

m_errorMessage

template<typename T = void>

std::string clara::detail::BasicResult< T >::m_errorMessage

protected

Definition at line 612 of file clara.hpp.

m_type

template<typename T = void>

Type clara::detail::ResultBase::m_type

protected

Definition at line 532 of file clara.hpp.

---

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

• libraries/sys-vm/external/Catch2/third_party/clara.hpp