Struct ProgressBar 

pub struct ProgressBar { /* private fields */ }

A configurable progress bar for iterative algorithms.

Thread-safe: the internal state is behind an Arc<Mutex<_>>.

Implementations

impl ProgressBar

pub fn new(total: u64) -> Self

Create a new progress bar with the given total number of steps.

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

Set the display style.

pub fn with_prefix(self, prefix: impl Into<String>) -> Self

Set the prefix label.

pub fn with_bar_width(self, width: usize) -> Self

Set the visual bar width (number of characters). Default: 30.

pub fn with_min_print_interval(self, interval: Duration) -> Self

Set the minimum interval between printed updates. Default: 100ms.

pub fn silent_finish(self) -> Self

Disable automatic printing on finish().

pub fn on_progress<F>(self, callback: F) -> Self

where F: Fn(u64, u64, Duration) + Send + 'static,

Register a callback that fires on each inc() / set() call.

pub fn inc(&mut self, delta: u64)

Increment the progress by delta steps.

pub fn set(&mut self, value: u64)

Set the progress to an absolute value.

pub fn finish(&mut self)

Mark the progress as finished and print a final line.

pub fn finish_with_message(&mut self, msg: &str)

Mark the progress as finished with a custom message.

pub fn reset(&mut self, total: u64)

Reset the progress bar to 0 with a new total.

pub fn position(&self) -> u64

Get the current position.

pub fn total(&self) -> u64

Get the total.

pub fn elapsed(&self) -> Duration

Get elapsed time.

pub fn rate(&self) -> f64

Get current rate (iterations/sec).

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

Get the estimated time remaining.

pub fn format_line(&self) -> String

Format the current state as a string (without printing).

Trait Implementations

impl Debug for ProgressBar

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

Formats the value using the given formatter.