Struct ProgressBar

pub struct ProgressBar { /* private fields */ }

A progress bar renders progress indication. Supports spinner and download templates. Can be used as a single progress bar and as part of a multi-progress bar (see MultiProgress).

Implemented via theming of indicatif::ProgressBar.

Implementations

impl ProgressBar

pub fn new(len: u64) -> Self

Creates a new progress bar with a given length.

pub fn with_spinner_template(self) -> Self

Sets a default spinner visual template for the progress bar.

pub fn with_download_template(self) -> Self

Sets a default visual template for downloading.

pub fn with_template(self, template: &str) -> Self

Sets a custom template string for the progress bar according to indicatif::ProgressStyle.

pub fn position(&self) -> u64

Returns the current position.

pub fn length(&self) -> Option<u64>

Returns the current length.

pub fn inc(&self, delta: u64)

Advances the position of the progress bar by a delta.

pub fn is_finished(&self) -> bool

Indicates that the progress bar is finished.

pub fn set_message(&self, message: impl Display)

Sets the current message of the progress bar ({msg} placeholder must be present in the template if you’re using a custom template via ProgressBar::with_template).

pub fn set_length(&self, len: u64)

Sets the length of the progress bar.

pub fn set_position(&self, pos: u64)

Sets the position of the progress bar.

pub fn start(&self, message: impl Display)

Starts the progress bar.

pub fn stop(&self, message: impl Display)

Stops the progress bar.

pub fn cancel(&self, message: impl Display)

Cancel the progress bar (stop with a cancelling style).

pub fn error(&self, message: impl Display)

Makes the progress bar stop with an error.

pub fn clear(&self)

Clears the progress bar.

Trait Implementations

impl Clone for ProgressBar

fn clone(&self) -> ProgressBar

Returns a duplicate of the value.

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

Performs copy-assignment from source.