fml::Status Class Reference

#include <status.h>

Public Member Functions
	Status ()
	Creates an 'ok' status.
	Status (fml::StatusCode code, std::string_view message)
fml::StatusCode	code () const
void	IgnoreError () const
bool	ok () const
std::string_view	message () const

Detailed Description

Class that represents the resolution of the execution of a procedure. This is used similarly to how exceptions might be used, typically as the return value to a synchronous procedure or an argument to an asynchronous callback.

Definition at line 35 of file status.h.

Constructor & Destructor Documentation

Status() [1/2]

fml::Status::Status ( )

inline

Creates an 'ok' status.

Definition at line 58 of file status.h.

: code_(fml::StatusCode::kOk), message_() {}

Status() [2/2]

fml::Status::Status ( fml::StatusCode  code, std::string_view  message  )

inline

Definition at line 60 of file status.h.

    : code_(code), message_(message) {}

Member Function Documentation

code()

fml::StatusCode fml::Status::code ( ) const

inline

Definition at line 63 of file status.h.

                                        {
  return code_;
}

IgnoreError()

void fml::Status::IgnoreError ( ) const

inline

A noop that helps with static analysis tools if you decide to ignore an error.

Definition at line 67 of file status.h.

                                      {
  // noop
}

message()

std::string_view fml::Status::message ( ) const

inline

Definition at line 75 of file status.h.

                                            {
  return message_;
}

ok()

bool fml::Status::ok ( ) const

inline

Returns

'true' when the code is kOk.

Definition at line 71 of file status.h.

                             {
  return code_ == fml::StatusCode::kOk;
}

---

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

• fml/status.h