Struct Value

pub struct Value {
    pub step: Arc<AtomicUsize>,
    pub done_at: Option<usize>,
    pub unit: Option<Unit>,
    pub state: State,
}

Available on crate feature progress only.

Progress associated with some item in the progress tree.

Fields

step: Arc<AtomicUsize>

The amount of progress currently made

done_at: Option<usize>

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

If unset, the progress is unbounded.

unit: Option<Unit>

The unit associated with the progress.

state: State

Whether progress can be made or not

Implementations

impl Value

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 Value

fn clone(&self) -> Value

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Value

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

Formats the value using the given formatter.

impl Default for Value

fn default() -> Value

Returns the “default value” for a type.

impl Hash for Value

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

where H: Hasher,

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.