retinify::Status Class Reference

This class represents the status of an operation in the retinify library. More...

#include <status.hpp>

Public Member Functions
	Status () noexcept=default
	Status (StatusCategory category, StatusCode code) noexcept
	~Status () noexcept=default
	Status (const Status &) noexcept=default
auto	operator= (const Status &) noexcept -> Status &=default
	Status (Status &&) noexcept=default
auto	operator= (Status &&) noexcept -> Status &=default
auto	IsOK () const noexcept -> bool
	Returns whether the status is OK.
auto	Category () const noexcept -> StatusCategory
	Returns the status category.
auto	Code () const noexcept -> StatusCode
	Returns the status code.

Detailed Description

This class represents the status of an operation in the retinify library.

Constructor & Destructor Documentation

Status() [1/4]

retinify::Status::Status ( )

defaultnoexcept

Status() [2/4]

retinify::Status::Status ( StatusCategory  category, StatusCode  code  )

explicitnoexcept

~Status()

retinify::Status::~Status ( )

defaultnoexcept

Status() [3/4]

retinify::Status::Status ( const Status &  )

defaultnoexcept

Status() [4/4]

retinify::Status::Status ( Status &&  )

defaultnoexcept

Member Function Documentation

Category()

auto retinify::Status::Category ( ) const -> StatusCategory

noexcept

Returns the status category.

Returns

The status category

Code()

auto retinify::Status::Code ( ) const -> StatusCode

noexcept

Returns the status code.

Returns

The status code

IsOK()

auto retinify::Status::IsOK ( ) const -> bool

noexcept

Returns whether the status is OK.

Returns

True if the status is OK; false otherwise

operator=() [1/2]

auto retinify::Status::operator= ( const Status &  ) -> Status &=default

defaultnoexcept

operator=() [2/2]

auto retinify::Status::operator= ( Status &&  ) -> Status &=default

defaultnoexcept

---

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

• /home/runner/work/retinify/retinify/retinify/include/retinify/status.hpp