Struct zzz::ProgressBar

pub struct ProgressBar { /* private fields */ }

Progress bar to be rendered on the terminal.

Example

use zzz::prelude::*;

let mut bar = ProgressBar::with_target(123);
for _ in 0..123 {
    bar.add(1);
}

Implementations

impl ProgressBar

Constructors.

pub fn smart() -> Self

Creates a smart progress bar, attempting to infer the target from size hints.

pub fn spinner() -> Self

Creates a spinner, a progress bar with indeterminate target value.

pub fn with_target(target: usize) -> Self

Creates a progress bar with an explicit target value.

impl ProgressBar

Builder-style methods.

pub fn config(self, cfg: &'static ProgressBarConfig) -> Self

Replace the config of the progress bar.

pub fn force_spinner(self) -> Self

Force display as a spinner even if size hints are present.

pub fn unit(self, unit: Unit) -> Self

Set the unit to be used when formatting values.

impl ProgressBar

Value manipulation and access.

pub fn process_size_hint(&mut self, hint: (usize, Option<usize>))

pub fn set(&mut self, n: usize)

Set the progress bar value to a new, absolute value.

This doesn’t automatically redraw the progress-bar.

See set_sync for a thread-safe version.

pub fn set_sync(&self, n: usize)

Synchronized version fo set.

pub fn add(&mut self, n: usize) -> usize

Add n to the value of the progress bar.

See add_sync for a thread-safe version.

pub fn add_sync(&self, n: usize) -> usize

Synchronized version fo add.

pub fn update_ctr(&self) -> usize

How often has the value been changed since creation?

pub fn value(&self) -> usize

Get the current value of the progress bar.

pub fn message(&self) -> Option<String>

Get the current task description text.

pub fn set_message(&mut self, text: Option<impl Into<String>>)

Set the current task description text.

pub fn set_message_sync(&self, text: Option<impl Into<String>>)

Synchronized version for set_message.

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

Calculate the current progress, 0.0 .. 1.0.

pub fn elapsed(&self) -> Duration

Calculate the elapsed time since creation of the progress bar.

pub fn eta(&self) -> Option<Duration>

Estimate the duration until completion.

pub fn iters_per_sec(&self) -> f32

Calculate the mean iterations per second since creation of the progress bar.

pub fn updates_per_sec(&self) -> f32

Calculate the mean progress bar updates per second since creation of the progress bar.

pub fn timer_progress(&self, timer: Duration) -> f32

Calculates the progress of a rolling timer.

Returned values are always between 0 and 1. Timers are calculated from the start of the progress bar.

pub fn redraw(&self)

Forces a redraw of the progress bar.

Trait Implementations

impl Drop for ProgressBar

fn drop(&mut self)

Executes the destructor for this type.