6 releases

0.1.2 Jul 30, 2022
0.1.1 Mar 23, 2022
0.0.2 Mar 7, 2022

#88 in Testing

Download history 51/week @ 2022-06-06 180/week @ 2022-06-13 207/week @ 2022-06-20 176/week @ 2022-06-27 185/week @ 2022-07-04 190/week @ 2022-07-11 138/week @ 2022-07-18 191/week @ 2022-07-25 265/week @ 2022-08-01 293/week @ 2022-08-08 228/week @ 2022-08-15 263/week @ 2022-08-22 207/week @ 2022-08-29 198/week @ 2022-09-05 255/week @ 2022-09-12 216/week @ 2022-09-19

900 downloads per month
Used in 2 crates

MIT license

49KB
617 lines

nutmeg - an unopinionated progress bar library

https://github.com/sourcefrog/cargo-mutants

Tests docs.rs crates.io libs.rs Maturity: Beta

Nutmeg draws terminal progress indicators while giving the application complete control over their appearance and content.

For more information: https://docs.rs/nutmeg

License: MIT

Example

From examples/basic.rs:

use std::io::Write; // to support write!()

// 1. Define a struct holding all the application state necessary to
// render the progress bar.
#[derive(Default)]
struct Model {
    i: usize,
    total: usize,
    last_file_name: String,
}

// 2. Define how to render the progress bar as a String.
impl nutmeg::Model for Model {
    fn render(&mut self, _width: usize) -> String {
        format!("{}/{}: {}", self.i, self.total, self.last_file_name)
    }
}

fn main() -> std::io::Result<()> {
    // 3. Create a View when you want to draw a progress bar.
    let mut view = nutmeg::View::new(Model::default(),
        nutmeg::Options::default());

    // 4. As the application runs, update the model via the view.
    let total_work = 100;
    view.update(|model| model.total = total_work);
    for i in 0..total_work {
        view.update(|model| {
            model.i += 1;
            model.last_file_name = format!("file{}.txt", i);
        });
        // 5. Interleave text output lines by writing to the view.
        if i % 10 == 3 {
            writeln!(view, "reached {}", i)?;
        }
        std::thread::sleep(std::time::Duration::from_millis(100));
    }

    // 5. The bar is automatically erased when dropped.
    Ok(())
}

asciicast

Dependencies

~0.5–6MB
~108K SLoC