api::Status Class Reference

#include <hermes_status.h>

Public Member Functions
	Status (StatusCode ret_code=HERMES_SUCCESS)
bool	Succeeded () const
bool	Acceptable () const
bool	Failed () const
bool	operator== (StatusCode code)
void	operator= (StatusCode code)
StatusCode	GetStatus () const
std::string	Msg () const

Detailed Description

Represents the return status of Hermes class methods and function calls.

Constructor & Destructor Documentation

Status()

api::Status::Status ( StatusCode  ret_code = HERMES_SUCCESS )

inlineexplicit

Create an object representing success status.

Member Function Documentation

Succeeded()

bool api::Status::Succeeded ( ) const

inline

Returns true if the call did exactly what the user expected

Here is the caller graph for this function:

Acceptable()

bool api::Status::Acceptable ( ) const

inline

Returns true if the call was success with caveat.

Failed()

bool api::Status::Failed ( ) const

inline

Returns true if the call failed with error.

Here is the caller graph for this function:

operator==()

bool api::Status::operator== ( StatusCode  code )

inline

Custom equality check against a StatusCode

operator=()

void api::Status::operator= ( StatusCode  code )

inline

Custom assignment operator from StatusCode

GetStatus()

StatusCode api::Status::GetStatus ( ) const

inline

StatusCode Getter

Msg()

std::string api::Status::Msg ( ) const

inline

Returns a message string

Here is the caller graph for this function:

---

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

• /home/runner/work/hermes/hermes/src/hermes_status.h