Struct ProgressBar 

pub struct ProgressBar { /* private fields */ }

A progress bar that tracks completion of a task.

Example

use pulsebar::ProgressBar;

let bar = ProgressBar::new(100).with_message("Downloading");
for _ in 0..100 {
    bar.advance(1);
}
bar.finish_success("Download complete");

Custom Format

use pulsebar::ProgressBar;

let bar = ProgressBar::new(1000)
    .with_message("Sync")
    .with_format("{msg} [{bar:30}] {pos}/{total} {rate}/s ETA {eta}");

Implementations

impl ProgressBar

pub fn new(total: u64) -> Self

Create a new progress bar with the given total.

pub fn with_message(self, message: &str) -> Self

Set the display message. Consumes and returns self for chaining.

pub fn with_style(self, style: Style) -> Self

Set the visual style. Consumes and returns self for chaining.

pub fn with_theme(self, theme: Theme) -> Self

Set the color theme. Consumes and returns self for chaining.

pub fn with_format(self, format: &str) -> Self

Set a custom format string. Consumes and returns self for chaining.

Supported placeholders: {msg}, {bar}, {bar:N}, {pos}, {total}, {pct}, {elapsed}, {rate}, {eta}.

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

Update the display message.

pub fn advance(&self, delta: u64)

Increment the position by delta.

pub fn set_position(&self, pos: u64)

Set the position to an absolute value (clamped to total).

pub fn position(&self) -> u64

Get the current position.

pub fn total(&self) -> u64

Get the total.

pub fn is_finished(&self) -> bool

Check if the bar is finished.

pub fn rate(&self) -> f64

Get the current throughput in items/second.

pub fn eta(&self) -> Option<f64>

Get the estimated time remaining in seconds, or None if unavailable.

pub fn finish(&self)

Mark the bar as finished.

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

Mark the bar as successfully completed with a message.

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

Mark the bar as failed with an error message.

Trait Implementations

impl Clone for ProgressBar

fn clone(&self) -> ProgressBar

Returns a duplicate of the value.

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

Performs copy-assignment from source.