Struct Progress

pub struct Progress { /* private fields */ }

Progress indicator.

Progress is created either

• directly with progress! macro (if you don’t need custom configuration) or
• by first creating ProgressBuilder with progress_builder! macro, setting custom options, and then creating Progress with build.

Progress is drawn

• using background thread to guarantee timely updates
• only if terminal is detected
• to STDERR starting with "\r"
• from the moment Progress is created until Progress is finished or dropped

See crate index for usage and examples.

Implementations

impl Progress

pub fn finish(&self)

Finishes Progress with 100% completion.

• Sets State of Progress to 100% completion.
• Draws Progress once with additional "\n" to move cursor to next line.
• Finishes Progress, i.e. there will be no further draws.

Examples

use ml_progress::progress;

eprintln!("Begin");
let progress = progress!(10)?;
progress.finish();
eprintln!("End");

Begin
################################################# 10/10 (0s)
End

pub fn finish_and_clear(&self)

Finishes and clears Progress.

• Clears drawn Progress by overwriting with spaces + "\r", leaving cursor at start of the cleared line.
• Finishes Progress, i.e. there will be no further draws.

Examples

use ml_progress::progress;

eprintln!("Begin");
let progress = progress!(10)?;
progress.finish_and_clear();
eprintln!("End");

Begin
End

pub fn finish_at_current_pos(&self)

Finishes Progress.

• Draws Progress once with additional "\n" to move cursor to next line.
• Finishes Progress, i.e. there will be no further draws.

Examples

use ml_progress::progress;

eprintln!("Begin");
let progress = progress!(10)?;
progress.inc(6);
progress.finish_at_current_pos();
eprintln!("End");

Begin
##############################-------------------- 6/10 (0s)
End

pub fn inc(&self, steps: u64)

Increments position of Progress.

Examples

use ml_progress::progress;

let progress = progress!(10)?;
progress.inc(6);
progress.finish_at_current_pos();

##############################-------------------- 6/10 (0s)

pub fn message(&self, message: impl Into<Cow<'static, str>>)

Sets the message shown by item message_fill.

Examples

use ml_progress::progress;

let progress = progress!(10; pos "/" total " " message_fill)?;
progress.inc(6);
progress.message("Hello, World!");
progress.finish_at_current_pos();

6/10 Hello, World!

pub fn state(&self) -> &Arc<Mutex<State>>

Returns current state of Progress.

Examples

use ml_progress::progress;

let progress = progress!(10)?;
progress.inc(6);
assert_eq!(progress.state().lock().pos(), 6);

Trait Implementations

impl Clone for Progress

fn clone(&self) -> Progress

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Drop for Progress

fn drop(&mut self)

Executes the destructor for this type.