FRIF::ReturnStatus Struct Reference

Information about the result of calling a FRIF API function. More...

#include <common.h>

Public Types
enum class	Result { Success = 0 , Failure }
	Possible outcomes when performing operations. More...

Public Member Functions
	operator bool () const noexcept

Public Attributes
Result	result {}
	The result of the operation.
std::optional< std::string >	message {}
	Information about the result.

Detailed Description

Information about the result of calling a FRIF API function.

Definition at line 28 of file common.h.

Member Enumeration Documentation

Result

enum class FRIF::ReturnStatus::Result

strong

Possible outcomes when performing operations.

Enumerator
Success	Successfully performed operation.
Failure	Failed to perform operation.

Definition at line 31 of file common.h.

Member Function Documentation

operator bool()

FRIF::ReturnStatus::operator bool ( ) const

explicitnoexcept

Returns

true if result is Result::Success, false otherwise.

Definition at line 32 of file libfrif_common.cpp.

Member Data Documentation

result

Result FRIF::ReturnStatus::result {}

The result of the operation.

Definition at line 40 of file common.h.

message

std::optional<std::string> FRIF::ReturnStatus::message {}

Information about the result.

Must match the regular expression [[:graph:] ]*.

Definition at line 45 of file common.h.

---

The documentation for this struct was generated from the following files:

• common.h
• libfrif_common.cpp