Struct stdcli::term::ProgressBar

pub struct ProgressBar { /* fields omitted */ }

A progress bar or spinner.

Methods

impl ProgressBar

fn new(len: u64) -> ProgressBar

Creates a new progress bar with a given length.

This progress bar by default draws directly to stderr.

fn hidden() -> ProgressBar

Creates a completely hidden progress bar.

This progress bar still responds to API changes but it does not have a length or render in any way.

fn new_spinner() -> ProgressBar

Creates a new spinner.

This spinner by default draws directly to stdout. This adds the default spinner style to it.

fn set_style(&self, style: ProgressStyle)

Overrides the stored style.

fn enable_steady_tick(&self, ms: u64)

Spawns a background thread to tick the progress bar.

When this is enabled a background thread will regularly tick the progress back in the given interval (milliseconds). This is useful to advance progress bars that are very slow by themselves.

When steady ticks are enabled calling .tick() on a progress bar does not do anything.

fn disable_steady_tick(&self)

Undoes enable_steady_tick.

fn tick(&self)

Manually ticks the spinner or progress bar.

This automatically happens on any other change to a progress bar.

fn inc(&self, delta: u64)

Advances the position of a progress bar by delta.

fn set_position(&self, pos: u64)

Sets the position of the progress bar.

fn set_length(&self, len: u64)

Sets the length of the progress bar.

fn set_prefix(&self, prefix: &str)

Sets the current prefix of the progress bar.

fn set_message(&self, msg: &str)

Sets the current message of the progress bar.

fn finish(&self)

Finishes the progress bar and leaves the current message.

fn finish_with_message(&self, msg: &str)

Finishes the progress bar and sets a message.

fn finish_and_clear(&self)

Finishes the progress bar and completely clears it.

fn set_draw_target(&self, target: ProgressDrawTarget)

Sets a different draw target for the progress bar.

This can be used to draw the progress bar to stderr for instance:

let pb = ProgressBar::new(100);
pb.set_draw_target(ProgressDrawTarget::stderr());

fn wrap_iter<It>(&self, it: It) -> ProgressBarIter<It> where
    It: Iterator, 

Wraps an iterator with the progress bar.

let v = vec![1, 2, 3];
let pb = ProgressBar::new(3);
for item in pb.wrap_iter(v.iter()) {
    // ...
}

Trait Implementations

impl Drop for ProgressBar

fn drop(&mut self)