GLnexus::Status Class Reference

Function status (return) codes. More...

#include <types.h>

Public Member Functions
	Status (StatusCode code=StatusCode::OK, const char *msg=nullptr) noexcept
	Default Status constructor. More...
	Status (StatusCode code, const char *msg, const std::string &noun)
	Extended Status constructor. More...
bool	ok () const noexcept
bool	bad () const noexcept
	operator StatusCode () const noexcept
	operator int () const noexcept
std::string	str () const

Static Public Member Functions
static Status	OK () noexcept

Detailed Description

Function status (return) codes.

GLnexus functions generally return Status to indicate success or failure. They throw exceptions only in truly "exceptional" circumstances (out of memory or assertion violations)

Constructor & Destructor Documentation

GLnexus::Status::Status ( StatusCode  code = StatusCode::OK, const char *  msg = nullptr  )

inlinenoexcept

Default Status constructor.

If provided, msg SHOULD be a string literal (not subject to moving or deallocation)

GLnexus::Status::Status ( StatusCode  code, const char *  msg, const std::string &  noun  )

inline

Extended Status constructor.

If provided, msg SHOULD BE a string literal (not subject to moving or deallocation). The 'noun' will be copied and thus needs not be a literal.

---

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

• include/types.h