Logo ROOT  
Reference Guide
Loading...
Searching...
No Matches
ROOT::RResultBase Class Reference

Common handling of the error case for RResult<T> (T != void) and RResult<void>.

RResultBase captures a possible runtime error that might have occurred. If the RResultBase leaves the scope unchecked, it will throw an exception. RResultBase should only be allocated on the stack, which is helped by deleting the new operator. RResultBase is movable but not copyable to avoid throwing multiple exceptions about the same failure.

Definition at line 97 of file RError.hxx.

Public Member Functions

 RResultBase (const RResultBase &other)=delete
 RResultBase (RResultBase &&other)=default
 ~RResultBase () noexcept(false)
std::optional< RErrorGetError () const
RResultBaseoperator= (const RResultBase &other)=delete
RResultBaseoperator= (RResultBase &&other)=default
void Throw ()
 Throws an RException with fError.

Static Public Member Functions

static RError ForwardError (RResultBase &&result, RError::RLocation &&sourceLocation)
 Used by R__FORWARD_ERROR in order to keep track of the stack trace.

Protected Member Functions

 RResultBase ()=default
 RResultBase (RError &&error)
bool Check ()
 Used by the RResult<T> bool operator.

Protected Attributes

std::unique_ptr< RErrorfError
 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::RResultBase:
ROOT::RResult< void > ROOT::RResult< T > ROOT::RResult< void >

Constructor & Destructor Documentation

◆ RResultBase() [1/4]

ROOT::RResultBase::RResultBase ( )
protecteddefault

◆ RResultBase() [2/4]

ROOT::RResultBase::RResultBase ( RError && error)
inlineexplicitprotected

Definition at line 105 of file RError.hxx.

◆ RResultBase() [3/4]

ROOT::RResultBase::RResultBase ( const RResultBase & other)
delete

◆ RResultBase() [4/4]

ROOT::RResultBase::RResultBase ( RResultBase && other)
default

◆ ~RResultBase()

ROOT::RResultBase::~RResultBase ( )

Definition at line 44 of file RError.cxx.

Member Function Documentation

◆ Check()

bool ROOT::RResultBase::Check ( )
inlineprotected

Used by the RResult<T> bool operator.

Definition at line 108 of file RError.hxx.

◆ ForwardError()

RError ROOT::RResultBase::ForwardError ( RResultBase && result,
RError::RLocation && sourceLocation )
inlinestaticnodiscard

Used by R__FORWARD_ERROR in order to keep track of the stack trace.

Definition at line 128 of file RError.hxx.

◆ GetError()

std::optional< RError > ROOT::RResultBase::GetError ( ) const
inline

Definition at line 122 of file RError.hxx.

◆ operator=() [1/2]

RResultBase & ROOT::RResultBase::operator= ( const RResultBase & other)
delete

◆ operator=() [2/2]

RResultBase & ROOT::RResultBase::operator= ( RResultBase && other)
default

◆ Throw()

void ROOT::RResultBase::Throw ( )

Throws an RException with fError.

Definition at line 61 of file RError.cxx.

Member Data Documentation

◆ fError

std::unique_ptr<RError> ROOT::RResultBase::fError
protected

This is the nullptr for an RResult representing success.

Definition at line 100 of file RError.hxx.

◆ fIsChecked

bool ROOT::RResultBase::fIsChecked {false}
protected

Switches to true once the user of an RResult object checks the object status.

Definition at line 102 of file RError.hxx.


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