16 unstable releases (6 breaking)

0.7.0 Apr 2, 2024
0.6.0 Oct 19, 2023
0.5.2 Aug 26, 2023
0.5.1 Jul 27, 2023
0.3.1 Feb 25, 2022

#106 in Command-line interface

Download history 7293/week @ 2024-04-02 5391/week @ 2024-04-09 6062/week @ 2024-04-16 5553/week @ 2024-04-23 4342/week @ 2024-04-30 4756/week @ 2024-05-07 5027/week @ 2024-05-14 4339/week @ 2024-05-21 5450/week @ 2024-05-28 6530/week @ 2024-06-04 4964/week @ 2024-06-11 5347/week @ 2024-06-18 4720/week @ 2024-06-25 4463/week @ 2024-07-02 3919/week @ 2024-07-09 3670/week @ 2024-07-16

17,794 downloads per month
Used in 7 crates

MIT/Apache

265KB
460 lines

tqdm Crates.io Version Crates.io Downloads Crates.io MSRV

Instantly make your loops show a smart progress meter - just wrap any iterable with tqdm(iterable), and you're done!

Rust implementation of the popular Python command line progress bar tool tqdm. The name "tqdm" derives from the Arabic word taqaddum (تقدّم) which can mean "progress", and is an abbreviation for "I love you so much" in Spanish (te quiero demasiado).

demo

Quick Start

Simply wrap tqdm::tqdm() around any iterable:

use tqdm::tqdm;
for i in tqdm(0..10000) {
    /* Your loop logic here */
}

This function returns a wrapper iterator that controls multiple progress bars, advancing the meter when next is called. Methods on the original iterable are bypassed using the auto-dereference trait, so they can be called with no overhead.

 76%|███████████████▉     | 7618/10000 [00:09<00:03, 782.14it/s]

Usage

Styles and other parameters can be configured in-place:

use tqdm::Style;
for i in tqdm(0..100)
    .style(Style::Balloon)
    .desc(Some("some description")) {
    /* Your loop logic here */
}
 47%|**********.          | 4792/10000 [00:06<00:06, 783.39it/s]

Expose the tqdm::Iter trait to allow method chaining:

use tqdm::Iter;
for i in (0..).take(10000).tqdm() {
    /* Your loop logic here */
}

Alternatively, create a progress bar with tqdm::pbar() and manually update it:

use tqdm::pbar;
let mut pbar = pbar(Some(44850));

for i in 0..300 {
    pbar.update(i).unwrap();
    /* Your loop logic here */
}

Advanced Usage

Multi-bars are also supported! Tqdm maintains a global registry to handle multiple bars:

use tqdm::tqdm;
for t in (0..3) {
    std::thread::spawn(move || {
        for i in tqdm(0..).desc(Some(i)) {
            /* Your loop logic here */
        }
    })
}
 38%|##########0               | 77/200 [00:00<00:01, 83.24it/s]
 77%|████████████████████      | 77/100 [00:00<00:00, 83.24it/s]
 19%|*****.                    | 77/400 [00:00<00:03, 83.24it/s]

Async iterator items can be tracked using tqdm::tqdm_async() (you may need an async runtime like tokio):

use tqdm::tqdm_async;

#[tokio::main]
async fn main() {
    use tokio::time::{sleep, Duration};
    let future_iter = (0..100).map(|i| sleep(Duration::from_secs_f64(i as f64 / 100.0)));
    futures::future::join_all(tqdm_async(future_iter)).await;
}

For more usage, please refer to doc.

License

Crates.io License

Dependencies

~2–10MB
~89K SLoC