Struct Progress

pub struct Progress<T> {
    pub bar: ProgressBar,
    pub value: T,
    /* private fields */
}

A wrapper for a progress bar with a displayable information. The value type T is typically a counter.

Fields

bar: ProgressBar

value: T

Implementations

impl<T> Progress<T>

pub fn new(value: T) -> Self

pub fn done(&self) -> bool

pub fn finish(&self)

pub fn finish_on_drop(self: Arc<Self>) -> FinishOnDrop<T, Arc<Self>>

Converts an Arc to a wrapper that automatically calls finish when dropped. The wrapper dereferences to Self.

impl<T: Display> Progress<T>

pub fn update_progress(&self)

pub fn update_until_done(&self, timeout: Duration)

Auto update progress in the current-thread.

Blocks the current thread, and updates at the interval provided. This method only exits when finish is called in another thread.

impl<T: Send + Sync + Display + 'static> Progress<T>

pub fn spawn_auto_update_thread( self: Arc<Self>, timeout: Duration, ) -> JoinHandle<()>

Trait Implementations

impl<T: Default> Default for Progress<T>

fn default() -> Self

Returns the “default value” for a type.