CCSDS::Result< T > Class Template Reference

Encapsulates a result that can hold either a value or an Error. More...

#include <CCSDSResult.h>

Public Member Functions
	Result (T value)
	Constructor for success case.
	Result (Error error)
	Constructor for failure case.
bool	has_value () const
	Checks if the result contains a valid value.
T &	value ()
	Retrieves the stored value.
const T &	value () const
Error	error () const
	Retrieves the stored error.
	operator bool () const
	Implicit conversion to bool, allowing usage like if (result).

Private Attributes
std::variant< T, Error >	data
	Holds either a valid value or an Error.

Detailed Description

template<typename T>
class CCSDS::Result< T >

Encapsulates a result that can hold either a value or an Error.

This class simplifies error handling by allowing functions to return either a valid result or an Error, reducing the need for exception handling.

Template Parameters

T	The type of value to be stored in the result.

Definition at line 82 of file CCSDSResult.h.

Constructor & Destructor Documentation

Result() [1/2]

template<typename T >

CCSDS::Result< T >::Result ( T  value )

inline

Constructor for success case.

Parameters

value

The successful result value.

Definition at line 90 of file CCSDSResult.h.

                    : data(std::move(value)) {
    }

Result() [2/2]

template<typename T >

CCSDS::Result< T >::Result ( Error  error )

inline

Constructor for failure case.

Parameters

error

The Error.

Definition at line 97 of file CCSDSResult.h.

                        : data(error) {
    }

Member Function Documentation

error()

template<typename T >

Error CCSDS::Result< T >::error ( ) const

inline

Retrieves the stored error.

Returns

The error.

Definition at line 120 of file CCSDSResult.h.

                                      {
      return std::get<Error>(data);
    }

has_value()

template<typename T >

bool CCSDS::Result< T >::has_value ( ) const

inline

Checks if the result contains a valid value.

Returns

True if a valid value is present, false otherwise.

Definition at line 104 of file CCSDSResult.h.

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

Here is the caller graph for this function:

operator bool()

template<typename T >

CCSDS::Result< T >::operator bool ( ) const

inlineexplicit

Implicit conversion to bool, allowing usage like if (result).

Returns

True if the result contains a value, false otherwise.

Definition at line 128 of file CCSDSResult.h.

{ return has_value(); }

Here is the call graph for this function:

value() [1/2]

template<typename T >

T & CCSDS::Result< T >::value ( )

inline

Retrieves the stored value.

Returns

A reference to the stored value.

Note

Ensure has_value() returns true before calling this.

Definition at line 113 of file CCSDSResult.h.

{ return std::get<T>(data); }

value() [2/2]

template<typename T >

const T & CCSDS::Result< T >::value ( ) const

inline

Definition at line 114 of file CCSDSResult.h.

{ return std::get<T>(data); }

Member Data Documentation

data

template<typename T >

std::variant<T, Error> CCSDS::Result< T >::data

private

Holds either a valid value or an Error.

Definition at line 83 of file CCSDSResult.h.

---

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

• inc/CCSDSResult.h