Enum Status

pub enum Status {
    Pending {
        total: Option<usize>,
    },
    Error {
        message: String,
    },
    Finished,
    Running,
    InProgress {
        done: usize,
        total: usize,
    },
}

Represents the status of a task.

There are 3 main states: Pending, Running, and finished. But since there are 2 types of running (iterative or spinner) and 3 types of finished (success and error), thus 5 variants

Variants

Pending

Represents a pending task, waiting to be executed.

The total field is optional. If it exists/is not null, it means the task is iterative and has a known end Otherwise, we assume it to be a spinner task. The total field exists in this Pending variant since if we use, say

Status::InProgress{done: 0, total: X};

to represent a pending task with a known total instead of

Status::Pending{total: X};

it is ambiguous whether or not the task has already started or not.

Fields

total: Option<usize>

Error

Self-explanatory

Fields

message: String

Finished

Self-explanatory

Running

Like InProgress but for non-iterative tasks (unknown total)

InProgress

An iterative task (known end and/or subtasks) is running.

done out of total tasks were finished The subtasks field is currently unused but will be in the future when we implement nested tasks TODO: implement subtasks

Fields

done: usize

total: usize

Trait Implementations

impl Debug for Status

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Status

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for Status

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Status

fn cmp(&self, other: &Status) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Status

fn eq(&self, other: &Status) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Status

fn partial_cmp(&self, other: &Status) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Status

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Status

impl StructuralPartialEq for Status