Struct ProgressStack 

pub struct ProgressStack { /* private fields */ }

A thread-safe, shared-clonable collection of Progress instances.

ProgressStack is designed to manage a dynamic list of progress indicators (bars, spinners, etc.) that typically render together (e.g., a multi-bar CLI).

Concurrency

This struct uses internal synchronization (via Arc and RwLock), making it safe to clone and share across threads. Cloning is cheap (pointer copy), and mutations on one clone are visible to all others.

Implementations

impl ProgressStack

pub fn new() -> Self

Creates a new, empty ProgressStack.

Examples

use atomic_progress::ProgressStack;

let stack = ProgressStack::new();
assert!(stack.is_empty());

pub fn push(&self, progress: Progress)

Adds a Progress instance to the stack.

The progress item is appended to the end of the collection.

Parameters

• progress: The progress indicator to add.

pub fn add_pb( &self, name: impl Into<CompactString>, total: impl Into<u64>, ) -> Progress

Creates a new progress bar, adds it to the stack, and returns the handle.

This is a shorthand for creating a Progress via Progress::new_pb and calling push.

Parameters

• name: The display name for the bar.
• total: The total count for the bar.

pub fn add_spinner(&self, name: impl Into<CompactString>) -> Progress

Creates a new spinner, adds it to the stack, and returns the handle.

This is a shorthand for creating a Progress via Progress::new_spinner and calling push.

Parameters

• name: The display name for the spinner.

pub fn snapshot(&self) -> ProgressStackSnapshot

Returns a snapshot of the state of all tracked progress instances.

This aggregates the current state of every progress bar in the stack. It is typically used by renderers to draw the current UI frame.

Performance

This acquires a read lock on the stack collection, and subsequently acquires read locks on each individual Progress state to copy their data.

pub fn items(&self) -> Vec<Progress>

Returns a list of handles to all Progress instances in the stack.

Since Progress is a cheap-to-clone handle (Arc), this returns a new vector containing clones of the handles. This allows you to retain access to the bars even if the stack is cleared or modified later.

pub fn is_all_finished(&self) -> bool

Checks if all progress instances in the stack are marked as finished.

Returns true if the stack is empty or if is_finished() returns true for every item.

pub fn clear(&self)

Removes all progress instances from the stack.

This clears the internal collection.

pub fn len(&self) -> usize

Returns the number of progress instances currently in the stack.

pub fn is_empty(&self) -> bool

Returns true if the stack contains no progress instances.

Trait Implementations

impl Clone for ProgressStack

fn clone(&self) -> ProgressStack

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProgressStack

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

Formats the value using the given formatter.

impl Default for ProgressStack

fn default() -> ProgressStack

Returns the “default value” for a type.