Struct indicatif::ProgressStyle

pub struct ProgressStyle { /* fields omitted */ }

Controls the rendering style of progress bars

Implementations

impl ProgressStyle

pub fn default_bar() -> ProgressStyle

Returns the default progress bar style for bars

pub fn default_spinner() -> Self

Returns the default progress bar style for spinners

pub fn tick_chars(self, s: &str) -> ProgressStyle

Sets the tick character sequence for spinners

pub fn tick_strings(self, s: &[&str]) -> ProgressStyle

Sets the tick string sequence for spinners

pub fn progress_chars(self, s: &str) -> ProgressStyle

Sets the progress characters (filled, current, to do)

You can pass more than three for a more detailed display. All passed grapheme clusters need to be of equal width.

pub fn with_key(
    self,
    key: &'static str,
    f: fn(_: &ProgressState) -> String
) -> ProgressStyle

Adds a custom key that references a &ProgressState to the template

pub fn template(self, s: &str) -> ProgressStyle

Sets the template string for the progress bar

Review the list of template keys for more information.

pub fn on_finish(self, finish: ProgressFinish) -> ProgressStyle

Sets the finish behavior for the progress bar

This behavior is invoked when ProgressBar or ProgressBarIter completes and ProgressBar::is_finished() is false. If you don’t want the progress bar to be automatically finished then call on_finish(None).

pub fn get_tick_str(&self, idx: u64) -> &str

Returns the tick string for a given number

pub fn get_final_tick_str(&self) -> &str

Returns the tick string for the finished state

pub fn get_on_finish(&self) -> &ProgressFinish

Returns the finish behavior

Trait Implementations

impl Clone for ProgressStyle

fn clone(&self) -> ProgressStyle

Returns a copy of the value.

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

Performs copy-assignment from source.