ROOT::RResult< void > Class Reference

RResult<void> has no data member and no Inspect() method but instead a Success() factory method.

Definition at line 264 of file RError.hxx.

Public Member Functions
	RResult (const RResult &other)=delete
	RResult (const RResult &other)=delete
	RResult (const void &value)
	RResult (RError &&error)
	RResult (RError &&error)
	RResult (RResult &&other)=default
	RResult (RResult &&other)=default
	RResult (void &&value)
	~RResult ()=default
	~RResult ()=default
RResult &	Forward (RError::RLocation &&sourceLocation)
	Used by R__FORWARD_RESULT in order to keep track of the stack trace in case of errors.
RResult &	Forward (RError::RLocation &&sourceLocation)
	Used by R__FORWARD_RESULT in order to keep track of the stack trace in case of errors.
const void &	Inspect ()
	If the operation was successful, returns a const reference to the inner type.
	operator bool ()
	operator bool ()
RResult &	operator= (const RResult &other)=delete
RResult &	operator= (const RResult &other)=delete
RResult &	operator= (RResult &&other)=default
RResult &	operator= (RResult &&other)=default
void	ThrowOnError ()
	Short-hand method to throw an exception in the case of errors.
void	Unwrap ()
	If the operation was successful, returns the inner type by value.
Public Member Functions inherited from ROOT::RResultBase
	RResultBase (const RResultBase &other)=delete
	RResultBase (RResultBase &&other)=default
	~RResultBase () noexcept(false)
std::optional< RError >	GetError () const
RResultBase &	operator= (const RResultBase &other)=delete
RResultBase &	operator= (RResultBase &&other)=default
void	Throw ()
	Throws an RException with fError.

Static Public Member Functions
static RResult	Success ()
	Returns a RResult<void> that captures the successful execution of the function.
Static Public Member Functions inherited from ROOT::RResultBase
static RError	ForwardError (RResultBase &&result, RError::RLocation &&sourceLocation)
	Used by R__FORWARD_ERROR in order to keep track of the stack trace.

Private Member Functions
	RResult ()=default
void	ThrowOnError ()

Private Attributes
std::optional< void >	fValue
	The result value, only present in case of successful execution.

Additional Inherited Members
Protected Member Functions inherited from ROOT::RResultBase
	RResultBase ()=default
	RResultBase (RError &&error)
bool	Check ()
	Used by the RResult<T> bool operator.
Protected Attributes inherited from ROOT::RResultBase
std::unique_ptr< RError >	fError
	This is the nullptr for an RResult representing success.
bool	fIsChecked {false}
	Switches to true once the user of an RResult object checks the object status.

#include <ROOT/RError.hxx>

Inheritance diagram for ROOT::RResult< void >:

Constructor & Destructor Documentation

RResult() [1/9]

ROOT::RResult< void >::RResult ( )

privatedefault

RResult() [2/9]

ROOT::RResult< void >::RResult ( RError && error )

inline

Definition at line 271 of file RError.hxx.

RResult() [3/9]

ROOT::RResult< void >::RResult ( const RResult< void > & other )

delete

RResult() [4/9]

ROOT::RResult< void >::RResult ( RResult< void > && other )

default

~RResult() [1/2]

ROOT::RResult< void >::~RResult ( )

default

RResult() [5/9]

ROOT::RResult< void >::RResult ( const void & value )

inline

Definition at line 219 of file RError.hxx.

RResult() [6/9]

ROOT::RResult< void >::RResult ( void && value )

inline

Definition at line 220 of file RError.hxx.

RResult() [7/9]

ROOT::RResult< void >::RResult ( RError && error )

inline

Definition at line 221 of file RError.hxx.

RResult() [8/9]

ROOT::RResult< void >::RResult ( const RResult< void > & other )

delete

RResult() [9/9]

ROOT::RResult< void >::RResult ( RResult< void > && other )

default

~RResult() [2/2]

ROOT::RResult< void >::~RResult ( )

default

Member Function Documentation

Forward() [1/2]

RResult & ROOT::RResult< void >::Forward ( RError::RLocation && sourceLocation )

inline

Used by R__FORWARD_RESULT in order to keep track of the stack trace in case of errors.

Definition at line 231 of file RError.hxx.

Forward() [2/2]

RResult & ROOT::RResult< void >::Forward ( RError::RLocation && sourceLocation )

inline

Used by R__FORWARD_RESULT in order to keep track of the stack trace in case of errors.

Definition at line 281 of file RError.hxx.

Inspect()

const void & ROOT::RResult< void >::Inspect ( )

inline

If the operation was successful, returns a const reference to the inner type.

If there was an error, Inspect() instead throws an exception.

Definition at line 240 of file RError.hxx.

operator bool() [1/2]

ROOT::RResult< void >::operator bool ( )

inlineexplicit

Definition at line 259 of file RError.hxx.

operator bool() [2/2]

ROOT::RResult< void >::operator bool ( )

inlineexplicit

Definition at line 296 of file RError.hxx.

operator=() [1/4]

RResult & ROOT::RResult< void >::operator= ( const RResult< void > & other )

delete

operator=() [2/4]

RResult & ROOT::RResult< void >::operator= ( const RResult< void > & other )

delete

operator=() [3/4]

RResult & ROOT::RResult< void >::operator= ( RResult< void > && other )

default

operator=() [4/4]

RResult & ROOT::RResult< void >::operator= ( RResult< void > && other )

default

Success()

static RResult ROOT::RResult< void >::Success ( )

inlinestatic

Returns a RResult<void> that captures the successful execution of the function.

Definition at line 270 of file RError.hxx.

ThrowOnError() [1/2]

void ROOT::RResult< void >::ThrowOnError ( )

inlineprivate

Definition at line 204 of file RError.hxx.

ThrowOnError() [2/2]

void ROOT::RResult< void >::ThrowOnError ( )

inline

Short-hand method to throw an exception in the case of errors.

Does nothing for successful RResults.

Definition at line 290 of file RError.hxx.

Unwrap()

void ROOT::RResult< void >::Unwrap ( )

inline

If the operation was successful, returns the inner type by value.

For move-only types, Unwrap can only be called once, as it yields ownership of the inner value to the caller using std::move, potentially leaving the RResult in an unspecified state.

If there was an error, Unwrap() instead throws an exception.

Definition at line 253 of file RError.hxx.

Member Data Documentation

fValue

std::optional<void> ROOT::RResult< void >::fValue

private

The result value, only present in case of successful execution.

Definition at line 201 of file RError.hxx.