Represents a Result that may have an error (error code) or a success value A type of "void" means there is no Result value, but there may be a failure. More...

#include <result.hpp>

Inheritance diagram for mtcore::Result< T, ErrType >:

[legend]

Public Types
using	Err = ErrType

using	ErrVal = Error<Err>

using	Value = T

Public Member Functions
	Result (const T &val)
	Creates a Result object from a success Allows for implicit casting by returning success value.

	Result (T &&val)
	Creates a Result object from a success Allows for implicit casting by returning success value.

bool	operator== (const Result &other) const noexcept
	Compares results.

bool	operator!= (const Result &other) const noexcept

bool	operator== (const T &other) const noexcept
	Compares Result to a value.

bool	operator!= (const T &other) const noexcept

bool	is_success () const noexcept
	Checks if is a successful Result (aka.

T	value () const noexcept
	Checks if is a successful Result (aka.

bool	is_error () const noexcept
	Checks if is an error Result.

bool	copy_if_present (std::remove_const_t< T > &out) const noexcept
	Copies into a reference the successful value if there is one.

bool	move_if_present (T &out) noexcept
	Moves into a reference the successful value if there is one.

ErrVal	error () const noexcept
	Returns the associated error Fails if there is no error;.

const T &	operator* () const noexcept
	Dereference the value (fails if an error value)

T const *	operator-> () const noexcept
	Dereference the value (fails if an error value)

T &	operator* ()
	Dereference the value (fails if an error value)

T *	operator-> ()
	Dereference the value (fails if an error value)

Result< void, Err >	to_void () const

template<typename R>
Result< R, Err >	with_success_val (const R &s)

Static Public Member Functions
static Result	from_error (const ErrVal &err)
	Creates a Result object from an error.

static Result	from_success (const T &val)
	Creates a Result object from a success.

Detailed Description

template<typename T, typename ErrType>
struct mtcore::Result< T, ErrType >

Represents a Result that may have an error (error code) or a success value A type of "void" means there is no Result value, but there may be a failure.

Represents a Result that has a success value or an error.

Template Parameters

T	Type of success object
T	Success Value
ErrType	Error Type

Definition at line 170 of file result.hpp.

Member Typedef Documentation

◆ Err

template<typename T, typename ErrType>

using mtcore::Result< T, ErrType >::Err = ErrType

Definition at line 171 of file result.hpp.

◆ ErrVal

template<typename T, typename ErrType>

using mtcore::Result< T, ErrType >::ErrVal = Error<Err>

Definition at line 172 of file result.hpp.

◆ Value

template<typename T, typename ErrType>

using mtcore::Result< T, ErrType >::Value = T

Definition at line 173 of file result.hpp.

Constructor & Destructor Documentation

◆ Result() [1/2]

template<typename T, typename ErrType>

mtcore::Result< T, ErrType >::Result ( const T & val )

inline

Creates a Result object from a success Allows for implicit casting by returning success value.

Parameters

val	Success code

Returns: Result object

Definition at line 185 of file result.hpp.

185: val(val) {}

Here is the caller graph for this function:

◆ Result() [2/2]

template<typename T, typename ErrType>

mtcore::Result< T, ErrType >::Result ( T && val )

inline

Creates a Result object from a success Allows for implicit casting by returning success value.

Parameters

val	Success code

Returns: Result object

Definition at line 193 of file result.hpp.

193: val(std::forward<T>(val)) {}

mtcore::Result

Represents a Result that may have an error (error code) or a success value A type of "void" means the...

Definition result.hpp:170

Member Function Documentation

◆ copy_if_present()

template<typename T, typename ErrType>

bool mtcore::Result< T, ErrType >::copy_if_present ( std::remove_const_t< T > & out ) const

inlinenodiscardnoexcept

Copies into a reference the successful value if there is one.

Definition at line 271 of file result.hpp.

                                                                                 {
      if (is_success()) {
        out = value();
      }
      return is_success();
    }

Here is the call graph for this function:

◆ error()

template<typename T, typename ErrType>

ErrVal mtcore::Result< T, ErrType >::error ( ) const

inlinenodiscardnoexcept

Returns the associated error Fails if there is no error;.

Definition at line 294 of file result.hpp.

                                                {
      ensure(is_error(), "CANNOT GET AN ERROR FROM A SUCCESSFUL RESUTL!");
      return std::get<ErrVal>(val);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ from_error()

template<typename T, typename ErrType>

static Result mtcore::Result< T, ErrType >::from_error ( const ErrVal & err )

inlinestatic

Creates a Result object from an error.

Parameters

err	Error code

Returns: Result object

Definition at line 200 of file result.hpp.

200{ return Result(err, 0); }

mtcore::Result::Result

Result(const T &val)

Creates a Result object from a success Allows for implicit casting by returning success value.

Definition result.hpp:185

Here is the call graph for this function:

Here is the caller graph for this function:

◆ from_success()

template<typename T, typename ErrType>

static Result mtcore::Result< T, ErrType >::from_success ( const T & val )

inlinestatic

Creates a Result object from a success.

Parameters

val	Success code

Returns: Result object

Definition at line 207 of file result.hpp.

207{ return Result(val); }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ is_error()

template<typename T, typename ErrType>

bool mtcore::Result< T, ErrType >::is_error ( ) const

inlinenodiscardnoexcept

Checks if is an error Result.

Definition at line 266 of file result.hpp.

266{ return std::holds_alternative<ErrVal>(val); }

Here is the caller graph for this function:

◆ is_success()

template<typename T, typename ErrType>

bool mtcore::Result< T, ErrType >::is_success ( ) const

inlinenodiscardnoexcept

Checks if is a successful Result (aka.

has a value)

Definition at line 253 of file result.hpp.

253{ return std::holds_alternative<T>(val); }

Here is the caller graph for this function:

◆ move_if_present()

template<typename T, typename ErrType>

bool mtcore::Result< T, ErrType >::move_if_present ( T & out )

inlinenodiscardnoexcept

Moves into a reference the successful value if there is one.

Definition at line 281 of file result.hpp.

                                                        {
      if (is_success()) {
        out = std::move(std::get<T>(val));
        val = std::monostate{};
        return true;
      }
      return is_success();
    }

Here is the call graph for this function:

◆ operator!=() [1/2]

template<typename T, typename ErrType>

bool mtcore::Result< T, ErrType >::operator!= ( const Result< T, ErrType > & other ) const

inlinenoexcept

Definition at line 234 of file result.hpp.

234{ return !(*this == other); }

Here is the call graph for this function:

◆ operator!=() [2/2]

template<typename T, typename ErrType>

bool mtcore::Result< T, ErrType >::operator!= ( const T & other ) const

inlinenoexcept

Definition at line 248 of file result.hpp.

248{ return !(*this == other); }

◆ operator*() [1/2]

template<typename T, typename ErrType>

T & mtcore::Result< T, ErrType >::operator* ( )

inline

Dereference the value (fails if an error value)

Definition at line 318 of file result.hpp.

                   {
      ensure(is_success(), "CANNNOT DERERFERENCE ERROR RESULT");
      return std::get<T>(val);
    }

Here is the call graph for this function:

◆ operator*() [2/2]

template<typename T, typename ErrType>

const T & mtcore::Result< T, ErrType >::operator* ( ) const

inlinenoexcept

Dereference the value (fails if an error value)

Definition at line 302 of file result.hpp.

                                        {
      ensure(is_success(), "CANNNOT DERERFERENCE ERROR RESULT");
      return std::get<T>(val);
    }

Here is the call graph for this function:

◆ operator->() [1/2]

template<typename T, typename ErrType>

T * mtcore::Result< T, ErrType >::operator-> ( )

inline

Dereference the value (fails if an error value)

Definition at line 326 of file result.hpp.

                    {
      ensure(is_success(), "CANNNOT DERERFERENCE ERROR RESULT");
      return &std::get<T>(val);
    }

Here is the call graph for this function:

◆ operator->() [2/2]

template<typename T, typename ErrType>

T const * mtcore::Result< T, ErrType >::operator-> ( ) const

inlinenoexcept

Dereference the value (fails if an error value)

Definition at line 310 of file result.hpp.

                                         {
      ensure(is_success(), "CANNNOT DERERFERENCE ERROR RESULT");
      return &std::get<T>(val);
    }

Here is the call graph for this function:

◆ operator==() [1/2]

template<typename T, typename ErrType>

bool mtcore::Result< T, ErrType >::operator== ( const Result< T, ErrType > & other ) const

inlinenoexcept

Compares results.

Parameters

other Other Result to compare against

Returns: True if results are equivalent

Definition at line 214 of file result.hpp.

                                                        {
      if (is_error()) {
        if (other.is_error()) {
          return error() == other.error();
        }
        return false;
      }
      if (other.is_error()) {
        return false;
      }
 
      if (is_success()) {
        if (other.is_success()) {
          return value() == other.value();
        }
        return false;
      }
      return false;
    }

Here is the call graph for this function:

◆ operator==() [2/2]

template<typename T, typename ErrType>

bool mtcore::Result< T, ErrType >::operator== ( const T & other ) const

inlinenoexcept

Compares Result to a value.

Parameters

other Other value to compare against

Returns: True if has value && value matches other

Definition at line 241 of file result.hpp.

                                                   {
      if (is_error()) {
        return false;
      }
      return value() == other;
    }

Here is the call graph for this function:

◆ to_void()

template<typename T, typename ErrType>

Result< void, Err > mtcore::Result< T, ErrType >::to_void ( ) const

inline

Definition at line 331 of file result.hpp.

                                      {
      if (is_error()) {
        return this->error();
      }
      return {};
    }

Here is the call graph for this function:

◆ value()

template<typename T, typename ErrType>

T mtcore::Result< T, ErrType >::value ( ) const

inlinenodiscardnoexcept

Checks if is a successful Result (aka.

has a value)

Definition at line 258 of file result.hpp.

                                           {
      ensure(is_success(), "CANNOT GET VALUE WHEN ONE IS NOT PRESENT");
      return std::get<T>(val);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ with_success_val()

template<typename T, typename ErrType>

template<typename R>

Result< R, Err > mtcore::Result< T, ErrType >::with_success_val ( const R & s )

inline

Definition at line 339 of file result.hpp.

                                                {
      if (is_error()) {
        return error();
      }
      return s;
    }

Here is the call graph for this function:

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

result.hpp

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ Err

◆ ErrVal

◆ Value

Constructor & Destructor Documentation

◆ Result() [1/2]

◆ Result() [2/2]

Member Function Documentation

◆ copy_if_present()

◆ error()

◆ from_error()

◆ from_success()

◆ is_error()

◆ is_success()

◆ move_if_present()

◆ operator!=() [1/2]

◆ operator!=() [2/2]

◆ operator*() [1/2]

◆ operator*() [2/2]

◆ operator->() [1/2]

◆ operator->() [2/2]

◆ operator==() [1/2]

◆ operator==() [2/2]

◆ to_void()

◆ value()

◆ with_success_val()