Struct ProgressBar 

pub struct ProgressBar {
    pub start: u64,
    pub goal: u64,
    pub get_progress: Arc<Mutex<dyn Fn() -> u64 + Send>>,
    pub style: Style,
}

A ProgressBar handles the animation of a progress bar.

Fields

start: u64

The start value of the progress. The start and goal values must be absolute values, not relative to each other. For example, if your ideal state is 700 and your current state is 500, set start to 500 and goal to 700. Vice versa, if you want to start at 50% of the progress, set start to 50 and goal to 100.

goal: u64

The goal value of the progress. It must be an absolute value, not relative to the start.

get_progress: Arc<Mutex<dyn Fn() -> u64 + Send>>

A closure to get the current progress value.

style: Style

Implementations

impl ProgressBar

pub fn new<F>( start: u64, goal: u64, get_progress: F, style: Style, ) -> ProgressBar

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

new() initializes a new progress bar.

Examples found in repository

examples/main.rs (line 37)

fn main() {
    // --------------------------------------------- //
    // ---------- Example: Progress Bar ------------ //
    // --------------------------------------------- //

    let progress_value = Arc::new(Mutex::new(0));

    // Create a clone of the progress_value for the other thread.
    let thread_progress_value = progress_value.clone();

    // Some work done in another thread.
    let do_some_work = thread::spawn(move || {
        let mut num = 0;
        while num <= 100 {
            thread::sleep(time::Duration::from_millis(20));

            let mut val = thread_progress_value.lock().unwrap();
            *val = num;

            num += 1;
        }
    });

    // Initialize a progress bar.
    let style = ProgressBarStyleBuilder::new() // `Style` provides builder pattern.
        .color(Color::Green)
        .bar_length(60)
        .build();
    let progress_bar = ProgressBar::new(0, 100, move || *progress_value.lock().unwrap(), style);

    let mut writer = std::io::stdout();

    // Start the progress bar.
    progress_bar.start(&mut writer);

    // Wait for the worker thread to finish.
    do_some_work.join().unwrap();

    // ------------------------------------------------- //
    // ---------- Example: Interactive Menu ------------ //
    // ------------------------------------------------- //

    let options = vec![
        "Tokyo".to_string(),
        "Saitama".to_string(),
        "Kanagawa".to_string(),
    ];

    // Initialize an interactive menu.
    let mut menu = InteractiveMenu::new(
        options.clone(),
        InteractiveMenuStyleBuilder::new() // `Style` provides builder pattern.
            .color(Color::Blue)
            .selected_prefix('*')
            .build(),
    );

    // Run the interactive menu.
    let selected_index = menu.run().unwrap();

    println!("You selected: {}", options[selected_index]);

    // ------------------------------------------------- //
    // ---------- Example: Loading Indicator ----------- //
    // ------------------------------------------------- //

    let loading_indicator = LoadingIndicator::new(Color::Red);
    loading_indicator.start();

    // Do some work while the loading indicator is running.
    let mut num = 0;
    while num <= 100 {
        thread::sleep(time::Duration::from_millis(20));
        num += 1;
    }

    // Stop the loading indicator.
    loading_indicator.stop();
}

pub fn start(&self, writer: &mut Stdout)

start() starts the animation of the progress bar. It displays from 0% and goes to 100%.

Examples found in repository

examples/main.rs (line 42)

fn main() {
    // --------------------------------------------- //
    // ---------- Example: Progress Bar ------------ //
    // --------------------------------------------- //

    let progress_value = Arc::new(Mutex::new(0));

    // Create a clone of the progress_value for the other thread.
    let thread_progress_value = progress_value.clone();

    // Some work done in another thread.
    let do_some_work = thread::spawn(move || {
        let mut num = 0;
        while num <= 100 {
            thread::sleep(time::Duration::from_millis(20));

            let mut val = thread_progress_value.lock().unwrap();
            *val = num;

            num += 1;
        }
    });

    // Initialize a progress bar.
    let style = ProgressBarStyleBuilder::new() // `Style` provides builder pattern.
        .color(Color::Green)
        .bar_length(60)
        .build();
    let progress_bar = ProgressBar::new(0, 100, move || *progress_value.lock().unwrap(), style);

    let mut writer = std::io::stdout();

    // Start the progress bar.
    progress_bar.start(&mut writer);

    // Wait for the worker thread to finish.
    do_some_work.join().unwrap();

    // ------------------------------------------------- //
    // ---------- Example: Interactive Menu ------------ //
    // ------------------------------------------------- //

    let options = vec![
        "Tokyo".to_string(),
        "Saitama".to_string(),
        "Kanagawa".to_string(),
    ];

    // Initialize an interactive menu.
    let mut menu = InteractiveMenu::new(
        options.clone(),
        InteractiveMenuStyleBuilder::new() // `Style` provides builder pattern.
            .color(Color::Blue)
            .selected_prefix('*')
            .build(),
    );

    // Run the interactive menu.
    let selected_index = menu.run().unwrap();

    println!("You selected: {}", options[selected_index]);

    // ------------------------------------------------- //
    // ---------- Example: Loading Indicator ----------- //
    // ------------------------------------------------- //

    let loading_indicator = LoadingIndicator::new(Color::Red);
    loading_indicator.start();

    // Do some work while the loading indicator is running.
    let mut num = 0;
    while num <= 100 {
        thread::sleep(time::Duration::from_millis(20));
        num += 1;
    }

    // Stop the loading indicator.
    loading_indicator.stop();
}