Struct ProgressBar 

pub struct ProgressBar { /* private fields */ }

Available on crate feature print only.

Handle for a progress bar (This is the internal state, the handle is Arc<ProgressBar>)

See Progress Bars

Implementations

impl ProgressBar

pub fn set_total(&self, total: u64)

Set the total steps (if the progress is finite)

pub fn child(self: &Arc<Self>, message: impl Into<String>) -> ProgressBarBuilder

Start building a child progress bar

Note that the child builder will keep this bar alive (displayed), even if the child is not spawned

pub fn done_with_message(self: Arc<Self>, message: &str)

Set the message to be printed and mark the bar as done

pub fn done_by_ref_with_message(&self, message: &str)

Set the message to be printed and mark the bar as done

pub fn set_done_message(&self, message: &str)

Change the message to be printed when the bar is done. Useful if information is not available yet when the bar is spawned.

This does NOT mark the bar as done, use done_with_message for that.

pub fn set_interrupted_message(&self, message: &str)

Change the message to be printed when the bar is interrupted. Useful if information is not available yet when the bar is spawned.

pub fn done(self: Arc<Self>)

Mark the progress bar as done and drop the handle.

This needs to be called if the bar is unbounded. Otherwise, the bar will display in the interrupted state when dropped.

If the progress is finite, then interrupted state is automatically determined (current != total)

pub fn done_by_ref(&self)

Same as done, but does not drop the bar.

Trait Implementations

impl Debug for ProgressBar

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

Formats the value using the given formatter.

impl Drop for ProgressBar

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.