Skip to content

Latest commit

 

History

History
65 lines (49 loc) · 1.77 KB

README.md

File metadata and controls

65 lines (49 loc) · 1.77 KB

progression

Minimalistic (174 SLOC) and fast (updates are throttled) Rust progress bar.

 00:00:05   475 / 1,000 [##########################                          ]  48% ETA 00:00:06
 00:00:04   394 / 1,000 [=====================>                              ]  39% ETA 00:00:07

Usage

cargo add progression

Dependencies are optional (disable with cargo add --no-default-features progression or default-features = false in Cargo.toml):

  • terminal_size — gets the terminal width
  • num-format — formats numbers with group separators

Example

use std::{thread, time::Duration};

fn main() {
    // Default
    for _ in progression::bar(0..1_000) {
        thread::sleep(Duration::from_millis(1));
    }

    // Cargo style
    for _ in progression::bar_with_config(0..1_000, progression::Config::cargo()) {
        thread::sleep(Duration::from_millis(1));
    }

    // Unicode style
    for _ in progression::bar_with_config(0..1_000, progression::Config::unicode()) {
        thread::sleep(Duration::from_millis(1));
    }

    // Uses `slice.chunks` internally for lower overhead on large numbers of items
    for _ in progression::bar_chunks(10, &[0; 1_000]) {
        thread::sleep(Duration::from_millis(1));
    }

    // Custom
    for _ in progression::bar_with_config(0..1_000,
            progression::Config { style: progression::Style::Mono('·'), ..Default::default() }) {
        thread::sleep(Duration::from_millis(1));
    }

    // Manual
    let items = vec![1, 2, 3, 4, 5];
    let bar = progression::Bar::new(items.len() as u64,
        progression::Config { prefix: "(items) ", ..progression::Config::cargo() });

    for _ in items {
        thread::sleep(Duration::from_millis(100));
        bar.inc(1);
    }

    bar.finish();
}