Struct Progress 

pub struct Progress {
    pub tasks: Vec<Task>,
    pub auto_refresh: bool,
    pub refresh_per_second: f64,
    pub transient: bool,
    pub columns: Option<Vec<Box<dyn ProgressColumn>>>,
    /* private fields */
}

A multi-task progress display.

Fields

tasks: Vec<Task>

auto_refresh: bool

refresh_per_second: f64

transient: bool

columns: Option<Vec<Box<dyn ProgressColumn>>>

Columns to render for each task (if None, uses default columns).

Implementations

impl Progress

pub fn new() -> Self

Create a new Progress instance with no tasks.

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

Replace the default columns with a custom list of ProgressColumns.

Each task is rendered as one row using the provided columns.

pub fn add_task( &mut self, description: impl Into<String>, total: Option<f64>, ) -> usize

Register a new task and return its numeric ID (used by advance, update, etc.).

pub fn advance(&mut self, task_id: usize, delta: f64)

Increase a task’s completed count by delta.

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

Set a task’s completed count directly (overwrites current value).

pub fn remove_task(&mut self, task_id: usize)

Remove a task by its ID. No-op if the task does not exist.

pub fn refresh(&mut self)

Force a refresh/render of the progress display. In a live display context this triggers a re-render.

pub fn start_task(&mut self, task_id: usize)

Mark a task as started (reset its start_time to now).

pub fn stop_task(&mut self, task_id: usize)

Mark a task as stopped (set its stop_time to now).

pub fn reset(&mut self, task_id: usize, total: Option<f64>)

Reset a task’s completed count.

If total is Some, also updates the task’s total.

pub fn finished(&self) -> bool

Check if all tasks are finished.

pub fn get_default_columns(&self) -> Vec<Box<dyn ProgressColumn>>

Get the default column set for rendering.

Returns: description, spinner, bar, percentage, elapsed.

pub fn get_renderable(&self, task_id: usize) -> Option<&dyn Renderable>

Get the renderable for a specific task, if any.

pub fn get_renderables(&self) -> Vec<&dyn Renderable>

Get all task renderables.

pub fn make_tasks_table(&self, columns: &[Box<dyn ProgressColumn>]) -> Table

Build a Table from tasks and progress columns.

Each visible task becomes a row, each column becomes a cell rendered by the corresponding ProgressColumn.

pub fn render(&self, width: usize) -> String

Render all visible tasks to a multi-line string at the given terminal width.

pub fn track<I: IntoIterator>( &mut self, sequence: I, description: &str, total: Option<f64>, ) -> TrackIterator<I::IntoIter>

Wrap an iterator with progress tracking, returning a TrackIterator.

Equivalent to Python Rich’s track().

pub fn advance_bytes(&mut self, task_id: usize, bytes: u64)

Convenience: advance a task by a u64 byte count (casts to f64 internally).

pub fn open( &mut self, path: impl AsRef<Path>, description: impl Into<String>, ) -> Result<ProgressFile>

Open a file at the given path and wrap it with progress tracking.

Returns a ProgressFile whose reads are recorded via this Progress.

pub fn wrap_file( &mut self, file: File, description: &str, total: Option<u64>, ) -> ProgressFile

Wrap an already-open std::fs::File with progress tracking.

Trait Implementations

impl Debug for Progress

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

Formats the value using the given formatter.

impl Default for Progress

fn default() -> Self

Returns the “default value” for a type.