HEBI C++ API  3.4.0
hebi::FunctionCallResult Class Reference

Used as a return. More...

#include <util.hpp>

Public Member Functions

 FunctionCallResult (bool success)
 
 FunctionCallResult (bool success, const std::string &failure)
 
 FunctionCallResult (FunctionCallResult &&)=default
 
FunctionCallResultoperator= (FunctionCallResult &&)=default
 
 operator bool () const
 
bool success () const
 
const std::string & failureMessage () const
 

Detailed Description

Used as a return.

Constructor & Destructor Documentation

◆ FunctionCallResult() [1/3]

hebi::FunctionCallResult::FunctionCallResult ( bool  success)
inlineexplicit

◆ FunctionCallResult() [2/3]

hebi::FunctionCallResult::FunctionCallResult ( bool  success,
const std::string &  failure 
)
inline

◆ FunctionCallResult() [3/3]

hebi::FunctionCallResult::FunctionCallResult ( FunctionCallResult &&  )
default

Member Function Documentation

◆ operator=()

FunctionCallResult& hebi::FunctionCallResult::operator= ( FunctionCallResult &&  )
default

◆ operator bool()

hebi::FunctionCallResult::operator bool ( ) const
inline

◆ success()

bool hebi::FunctionCallResult::success ( ) const
inline

◆ failureMessage()

const std::string& hebi::FunctionCallResult::failureMessage ( ) const
inline

The failure message, if the call this represents failed.

On success, this will always be a valid empty string (i.e., result.failureMessage().empty() is always true).


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