Struct prodash::tree::Progress

pub struct Progress {
    pub step: ProgressStep,
    pub done_at: Option<ProgressStep>,
    pub unit: Option<&'static str>,
    pub state: ProgressState,
}

Progress associated with some item in the progress tree.

Fields

step: ProgressStep

The amount of progress currently made

done_at: Option<ProgressStep>

The step at which no further progress has to be made.

If unset, the progress is unbounded.

unit: Option<&'static str>

The unit associated with the progress.

state: ProgressState

Whether progress can be made or not

Methods

impl Progress

pub fn fraction(&self) -> Option<f32>

Returns a number between Some(0.0) and Some(1.0), or None if the progress is unbounded.

A task half done would return Some(0.5).

Trait Implementations

impl Clone for Progress

fn clone(&self) -> Progress

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for Progress

impl Debug for Progress

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

Formats the value using the given formatter.

impl Default for Progress

fn default() -> Progress

Returns the "default value" for a type.

impl Eq for Progress

impl Hash for Progress

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, 

Feeds a slice of this type into the given [Hasher].

impl Ord for Progress

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Progress> for Progress

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Progress> for Progress

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl StructuralEq for Progress

impl StructuralPartialEq for Progress