Struct ProgressBarBuilder 

pub struct ProgressBarBuilder { /* private fields */ }

Available on crate feature print only.

Builder for a progress bar

Implementations

impl ProgressBarBuilder

pub fn new(message: String) -> Self

Start building a progress bar. Note cu::progress is the canonical shorthand

pub fn total(self, total: usize) -> Self

Set the total steps. 0 means total is unknown, which can be set at a later point.

By default, the progress bar is “unbounded”, meaning there is no individual steps

cu::progress("doing something").total(10);

pub fn total_bytes(self, total: u64) -> Self

Set the total bytes and set the progress to be displayed using byte units (SI). 0 means total is unknown, which can be set at a later point.

cu::progress("doing something").total_bytes(1000000);

pub fn keep(self, keep: bool) -> Self

Set if the progress bar should be kept in the output after it’s done.

Default is true for root progress bars and false for child progress bars

cu::progress("doing something").keep(false);

pub fn eta(self, show: bool) -> Self

Set if ETA (estimated time) should be displayed. Only effective if total is not zero (i.e. not unbounded). Default is true

cu::progress("doing something").total(10).eta(false);

pub fn percentage(self, show: bool) -> Self

Set if percentage should be displayed. Only effective if total is not zero (i.e. not unbounded). Default is true

cu::progress("doing something").total(10).percentage(false);

pub fn when_done(self, message: impl Into<String>) -> Self

Set a message to be displayed when the progress is done. Requires keep(true) - which is the default, but when_done will not automatically turn it on for you.

Default is the message of the progress bar followed by done.

cu::progress("doing something").when_done("something is done!");

pub fn when_interrupt(self, message: impl Into<String>) -> Self

Set a message to be displayed when the progress is interrupted.

Default is the message of the progress bar followed by interrupted.

cu::progress("doing something").when_interrupt("something is interrupted!");

pub fn max_display_children(self, num: usize) -> Self

Set the max number of children to display at a time. Default is unbounded.

cu::progress("doing something").max_display_children(30);

pub fn parent(self, parent: Option<Arc<ProgressBar>>) -> Self

Set the parent progress bar.

If the parent is known to be Some, use parent.child(...) instead

pub fn spawn(self) -> Arc<ProgressBar>

Build and start displaying the bar in the console

Trait Implementations

impl Clone for ProgressBarBuilder

fn clone(&self) -> ProgressBarBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProgressBarBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.