zpp::result< void, T_Error > Class Template Reference

result class More...

#include <result.hpp>

Public Member Functions
	result () noexcept=default
	default initialization to error state More...
	result (const error_result< T_Error > &rhs) noexcept
	initialization to error state More...
	result (error_result< T_Error > &&rhs) noexcept
	result (const result &rhs) noexcept=default
	copy contructor More...
	result (result &&rhs) noexcept=default
	move contructor More...
	~result () noexcept=default
	destructor More...
result &	operator= (const result &rhs) noexcept=default
	copy operator More...
result &	operator= (result &&rhs) noexcept=default
	move operator More...
void	assign_value () noexcept
void	assign_error (const T_Error &e) noexcept
void	assign_error (T_Error &&e) noexcept
result &	operator= (const error_result< T_Error > &rhs) noexcept
	copy operator More...
result &	operator= (error_result< T_Error > &&rhs) noexcept
	move operator More...
void	value () noexcept
	return a reference to the OK value More...
void	value () const noexcept
	return a const reference to the result value More...
T_Error &	error () noexcept
	return a reference to the OK value More...
const T_Error &	error () const noexcept
	return a const reference to the result value More...
constexpr bool	has_value () const noexcept
	convert the result to a bool More...
constexpr	operator bool () const noexcept
	convert the result to a bool More...

Detailed Description

template<typename T_Error>
class zpp::result< void, T_Error >

result class

Parameters

T_Ok	the type for the OK result
T_Error	the type for the error result

Definition at line 467 of file result.hpp.

Constructor & Destructor Documentation

result() [1/5]

template<typename T_Error >

zpp::result< void, T_Error >::result ( )

defaultnoexcept

default initialization to error state

result() [2/5]

template<typename T_Error >

zpp::result< void, T_Error >::result ( const error_result< T_Error > &  rhs )

inlinenoexcept

initialization to error state

Parameters

rhs	the error value to assign

Definition at line 484 of file result.hpp.

    : m_is_ok(false)
    , m_error_value( rhs.error() )
  {
  }

result() [3/5]

template<typename T_Error >

zpp::result< void, T_Error >::result ( error_result< T_Error > &&  rhs )

inlinenoexcept

Definition at line 490 of file result.hpp.

    : m_is_ok(false)
    , m_error_value( std::move(rhs.error()) )
  {
  }

result() [4/5]

template<typename T_Error >

zpp::result< void, T_Error >::result ( const result< void, T_Error > &  rhs )

defaultnoexcept

copy contructor

Parameters

rhs	the value to assign

result() [5/5]

template<typename T_Error >

zpp::result< void, T_Error >::result ( result< void, T_Error > &&  rhs )

defaultnoexcept

move contructor

Parameters

rhs	the value to assign

~result()

template<typename T_Error >

zpp::result< void, T_Error >::~result ( )

defaultnoexcept

destructor

Member Function Documentation

assign_error() [1/2]

template<typename T_Error >

void zpp::result< void, T_Error >::assign_error ( const T_Error &  e )

inlinenoexcept

Definition at line 534 of file result.hpp.

                                               {
    m_is_ok = false;
    m_error_value = T_Error(e);
  }

References zpp::result< T_Ok, T_Error >::m_error_value.

assign_error() [2/2]

template<typename T_Error >

void zpp::result< void, T_Error >::assign_error ( T_Error &&  e )

inlinenoexcept

Definition at line 539 of file result.hpp.

                                          {
    m_is_ok = false;
    m_error_value = T_Error(std::move(e));
  }

References zpp::result< T_Ok, T_Error >::m_error_value.

assign_value()

template<typename T_Error >

void zpp::result< void, T_Error >::assign_value ( )

inlinenoexcept

Definition at line 530 of file result.hpp.

                               {
    m_is_ok = true;
  }

error() [1/2]

template<typename T_Error >

const T_Error& zpp::result< void, T_Error >::error ( ) const

inlinenoexcept

return a const reference to the result value

Returns

T_Ok const reference

Warning

when the result is in error state the the thread will terminate

Definition at line 614 of file result.hpp.

                                        {
    if (m_is_ok) {
      // unhandeld error
    }
 
    return m_error_value;
  }

References zpp::result< T_Ok, T_Error >::m_error_value.

error() [2/2]

template<typename T_Error >

T_Error& zpp::result< void, T_Error >::error ( )

inlinenoexcept

return a reference to the OK value

Returns

T_Ok reference

Warning

when the result is in error state the the thread will terminate

Definition at line 599 of file result.hpp.

                            {
    if (m_is_ok) {
      // unhandeld error
    }
 
    return m_error_value;
  }

References zpp::result< T_Ok, T_Error >::m_error_value.

has_value()

template<typename T_Error >

constexpr bool zpp::result< void, T_Error >::has_value ( ) const

inlineconstexprnoexcept

convert the result to a bool

Returns

true if the result is valid

Definition at line 627 of file result.hpp.

                                            {
    return m_is_ok;
  }

operator bool()

template<typename T_Error >

constexpr zpp::result< void, T_Error >::operator bool ( ) const

inlineexplicitconstexprnoexcept

convert the result to a bool

Returns

true if the result is valid

Definition at line 636 of file result.hpp.

                                                    {
    return m_is_ok;
  }

operator=() [1/4]

template<typename T_Error >

result& zpp::result< void, T_Error >::operator= ( const error_result< T_Error > &  rhs )

inlinenoexcept

copy operator

Parameters

rhs	the value to assign

Definition at line 549 of file result.hpp.

  {
    assign_error(rhs.error());
    return *this;
  }

References zpp::result< T_Ok, T_Error >::assign_error().

operator=() [2/4]

template<typename T_Error >

result& zpp::result< void, T_Error >::operator= ( const result< void, T_Error > &  rhs )

defaultnoexcept

copy operator

Parameters

rhs	the value to assign

operator=() [3/4]

template<typename T_Error >

result& zpp::result< void, T_Error >::operator= ( error_result< T_Error > &&  rhs )

inlinenoexcept

move operator

Parameters

rhs	the value to assign

Definition at line 560 of file result.hpp.

  {
    assign_error(std::move(rhs.error()));
    return *this;
  }

References zpp::result< T_Ok, T_Error >::assign_error().

operator=() [4/4]

template<typename T_Error >

result& zpp::result< void, T_Error >::operator= ( result< void, T_Error > &&  rhs )

defaultnoexcept

move operator

Parameters

rhs	the value to assign

value() [1/2]

template<typename T_Error >

void zpp::result< void, T_Error >::value ( ) const

inlinenoexcept

return a const reference to the result value

Returns

T_Ok const reference

Warning

when the result is in error state the the thread will terminate

Definition at line 586 of file result.hpp.

                              {
    if (!m_is_ok) {
      // unhandeld error
    }
  }

value() [2/2]

template<typename T_Error >

void zpp::result< void, T_Error >::value ( )

inlinenoexcept

return a reference to the OK value

Returns

T_Ok reference

Warning

when the result is in error state the the thread will terminate

Definition at line 573 of file result.hpp.

                        {
    if (!m_is_ok) {
      // unhandeld error
    }
  }

---

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

• include/zpp/result.hpp