Struct CliProgressBar 

pub struct CliProgressBar {
    pub value: usize,
    pub total: usize,
    pub message: String,
}

A progress bar for displaying task completion in the terminal.

This struct maintains the state of a progress bar and provides methods to update and render it. The bar displays percentage, a message, and a visual indicator of progress.

Fields

value: usize

Current value of progress (0 to total).

total: usize

Total value representing 100% completion.

message: String

Message displayed alongside the progress bar.

Implementations

impl CliProgressBar

pub fn start(&self)

Initializes and displays the progress bar.

Renders the progress bar on a new line at its initial state (0%).

pub fn increment(&mut self, num: usize)

Increments the progress value and updates the display.

Arguments

• num - The amount to increment the progress by

Example

let mut bar = cli_progress_bar("Processing", 100);
bar.increment(10); // Progress is now at 10%
bar.increment(15); // Progress is now at 25%

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

Sets the progress to a specific value and updates the display.

Arguments

• value - The new progress value (clamped to total)

Example

let mut bar = cli_progress_bar("Processing", 100);
bar.set(50); // Set progress to 50%

pub fn finish(&mut self)

Completes the progress bar.

Sets the progress to 100%, renders the final state, and moves to a new line.

Example

let mut bar = cli_progress_bar("Processing", 100);
// ... do work ...
bar.finish();