spp

Simple progress printer for rust

[123/456] Doing something: 26.97% ETA 35.20s current step ...

The progress style is inspired by ninja (the build tool)

Features

• Prints to stderr to integrate with pipes easily (final status printed to stdout)
• Handles throttling internally
• Display ETA after 2 seconds
• Display current job
• Display current step in the job (for example which file is currently being processed, etc)

Install

There's already a million progress printing library on crates.io, so I don't intend to publish mine there. However if you want to use mine you can directly install from GitHub

cargo add spp --git https://github.com/Pistonight/spp --branch main

Usage

fn my_func() {
    let total_steps = 500;
    let progress = spp::printer(total_steps, "Doing something")
    // You can also:
    // use spp::Printer;
    // let progress = Printer::new(...);

    for i in 0..total_steps {
        // here you can print for example what's the current file
        // being worked on, etc...
        progress.print(i, format!("current step: {i}"))

        // do your work...
    }
    // Print the final message and start a new line
    progress.done()
}

Throttling

You can customize the throttling interval, which is 50ms by default

let mut progress = spp::printer(500, "Doing Something");
progress.set_throttle_duration(std::time::Duration::from_millis(200));

Finishing

Calling progress.done() will print the final message with the current step equal to the total step, like

[500/500] Doing Something

You usually want this, but you can also intentionally omit this, so the next progress reuses the same line.