Amino::TaskStatus Class Reference

The completion status of a task. More...

#include <TaskObserver.h>

Public Types
enum	Status : uint8_t { eSuccess = 0 , eCancelled , eError , eDropped }

Public Member Functions
	TaskStatus ()=default
	Default constructor (eSuccess status). More...
	TaskStatus (Status status) noexcept
	Constructor. More...
	operator Status () const
	Get the status of the task. More...
	operator bool () const
	Whether the task completed successfully. More...

Detailed Description

The completion status of a task.

Definition at line 46 of file TaskObserver.h.

Member Enumeration Documentation

Status

enum Amino::TaskStatus::Status : uint8_t

Enumerator
eSuccess	The task completed successfully.
eCancelled	The task was cancelled explicitly by the user.
eError	The task failed due to an error.
eDropped	The task was dropped (because it was destroyed or cancelled before it started).

Definition at line 50 of file TaskObserver.h.

Constructor & Destructor Documentation

TaskStatus() [1/2]

Amino::TaskStatus::TaskStatus ( )

default

Default constructor (eSuccess status).

TaskStatus() [2/2]

Amino::TaskStatus::TaskStatus ( Status  status )

inlinenoexcept

Constructor.

Definition at line 72 of file TaskObserver.h.

Member Function Documentation

operator bool()

Amino::TaskStatus::operator bool ( ) const

inlineexplicit

Whether the task completed successfully.

Definition at line 79 of file TaskObserver.h.

References eSuccess.

operator Status()

Amino::TaskStatus::operator Status ( ) const

inline

Get the status of the task.

Definition at line 76 of file TaskObserver.h.