Struct Progress

Source

pub struct Progress { /* private fields */ }

Expand description

Multi-task progress display with optional Live-like lifecycle.

Supports start/stop methods with cursor hiding for flicker-free updates. When auto_refresh is enabled, a background thread refreshes the display at the specified refresh_per_second rate.

Implementations§

Source §

impl Progress

Source

pub fn new() -> Self

Create a new progress display with default columns.

Source

pub fn with_console(self, console: Console) -> Self

Create a progress display with a Console (enables start/stop lifecycle).

Source

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

Set whether output is cleared on stop (transient mode).

Source

pub fn refresh_per_second(self, rate: f64) -> Self

Set the refresh rate in Hz (refreshes per second).

Default is 10.0. Set lower if updates are infrequent to reduce CPU usage.

Source

pub fn auto_refresh(self, enabled: bool) -> Self

Enable or disable auto-refresh.

When enabled (default), a background thread automatically refreshes the display. When disabled, you must call refresh() manually after updating tasks.

Source

pub fn with_columns(self, columns: Vec<Box<dyn ProgressColumn>>) -> Self

Set custom columns.

Source

pub fn add_task(&self, description: &str, total: Option<u64>) -> usize

Add a new task.

Source

pub fn advance(&self, task_id: usize, amount: u64)

Advance a task by the given amount.

Source

pub fn update(&self, task_id: usize, completed: u64)

Update a task’s completed count.

Source

pub fn finish(&self, task_id: usize)

Mark a task as finished.

Source

pub fn remove(&self, task_id: usize)

Remove a task.

Source

pub fn is_finished(&self) -> bool

Check if all tasks are finished.

Source

pub fn render_to_string(&self) -> String

Render the progress display.

Source

pub fn print(&self)

Print the progress to stdout (with cursor control for updates).

Source

pub fn start(&mut self)

Start the live progress display.

Hides the cursor and prepares for flicker-free updates via refresh(). When auto_refresh is enabled, spawns a background thread for automatic updates. Must have a Console set via with_console() to use this method.

Source

pub fn stop(&mut self)

Stop the live progress display.

Shows the cursor and optionally clears the output (if transient mode is enabled). If a background refresh thread is running, it will be stopped.

Source

pub fn refresh(&mut self)

Refresh the progress display.

When used with start/stop lifecycle, provides flicker-free updates. Can also be used standalone as an improved version of print().

Source

pub fn run<F, R>(&mut self, f: F) -> R
where F: FnOnce(&mut Self) -> R,

Execute a closure with automatic progress lifecycle management.

Provides RAII-style progress management similar to Python’s with Progress() as progress: pattern. Automatically calls start() before the closure and stop() after, even if the closure panics.

§Example

progress.run(|p| {
    let task = p.add_task("Working", Some(100));
    for i in 0..100 {
        p.advance(task, 1);
        p.refresh();
        thread::sleep(Duration::from_millis(50));
    }
});