hebi::FunctionCallResult Class Reference

Used as a return. More...

#include <util.hpp>

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

Private Attributes
std::string	failure_message_
bool	ok_

Detailed Description

Used as a return.

Definition at line 28 of file util.hpp.

Constructor & Destructor Documentation

FunctionCallResult() [1/3]

hebi::FunctionCallResult::FunctionCallResult ( bool  success )

inlineexplicit

Definition at line 30 of file util.hpp.

FunctionCallResult() [2/3]

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

inline

Definition at line 31 of file util.hpp.

FunctionCallResult() [3/3]

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

default

Member Function Documentation

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).

Definition at line 43 of file util.hpp.

operator bool()

hebi::FunctionCallResult::operator bool ( ) const

inline

Definition at line 35 of file util.hpp.

operator=()

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

default

success()

bool hebi::FunctionCallResult::success ( ) const

inline

Definition at line 36 of file util.hpp.

Member Data Documentation

failure_message_

std::string hebi::FunctionCallResult::failure_message_

private

Definition at line 46 of file util.hpp.

ok_

bool hebi::FunctionCallResult::ok_

private

Definition at line 45 of file util.hpp.

---

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

• util.hpp