Struct ProgressBar 

pub struct ProgressBar { /* private fields */ }

A progress bar for displaying operation progress.

Example

use click::termui::ProgressBar;

let mut bar = ProgressBar::new(100, Some("Processing"), true, true, true, 40);

for i in 0..100 {
    // Do work...
    bar.update(1);
}

bar.finish();

// Custom fill/empty characters
let mut bar = ProgressBar::new(100, None, true, true, false, 30)
    .fill_char('█')
    .empty_char('░');

Implementations

impl ProgressBar

pub fn new( length: usize, label: Option<&str>, show_eta: bool, show_percent: bool, show_pos: bool, width: usize, ) -> Self

Create a new progress bar.

Arguments

• length - Total number of items to process
• label - Optional label to display before the bar
• show_eta - Whether to show estimated time remaining
• show_percent - Whether to show percentage complete
• show_pos - Whether to show position/length
• width - Width of the bar portion in characters

pub fn fill_char(self, c: char) -> Self

Set the character used for the filled portion of the bar.

Default is ‘#’.

Example

use click::termui::ProgressBar;
let bar = ProgressBar::new(100, None, true, true, false, 30)
    .fill_char('█');

pub fn empty_char(self, c: char) -> Self

Set the character used for the empty portion of the bar.

Default is ‘-’.

Example

use click::termui::ProgressBar;
let bar = ProgressBar::new(100, None, true, true, false, 30)
    .empty_char('░');

pub fn update(&mut self, n: usize)

Update the progress bar by advancing by n items.

Arguments

• n - Number of items completed since last update

pub fn set_position(&mut self, pos: usize)

Set the progress bar to a specific position.

Arguments

• pos - New position

pub fn finish(&mut self)

Mark the progress bar as finished and render final state.

pub fn render(&self) -> String

Render the current progress bar state to a string.

Trait Implementations

impl Drop for ProgressBar

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.