https://github.com/a8m/pb

Console progress bar for Rust
https://github.com/a8m/pb

pb pbr progress-bar progressbar rust

Last synced: 5 days ago
JSON representation

Console progress bar for Rust

• Host: GitHub
• URL: https://github.com/a8m/pb
• Owner: a8m
• License: mit
• Created: 2015-10-14T19:08:31.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2024-01-10T15:37:51.000Z (10 months ago)
• Last Synced: 2024-10-20T22:53:25.658Z (15 days ago)
• Topics: pb, pbr, progress-bar, progressbar, rust
• Language: Rust
• Homepage:
• Size: 8.89 MB
• Stars: 583
• Watchers: 13
• Forks: 59
• Open Issues: 24
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-rust-cn - a8m/pb
• awesome-rust - a8m/pb
• awesome-rust - a8m/pb
• awesome-rust-cn - a8m/pb
• awesome-rust-zh - a8m/pb - Rust 的控制台进度条 (库 / 命令行)
• awesome-rust - a8m/pb - console progress bar (Libraries / Command-line)
• awesome-rust - a8m/pb
• fucking-awesome-rust - a8m/pb - console progress bar (Libraries / Command-line)
• fucking-awesome-rust - a8m/pb - console progress bar (Libraries / Command-line)

README

        
# Terminal progress bar for Rust

[![Latest version](https://img.shields.io/crates/v/pbr.svg)](https://crates.io/crates/pbr)

[![License](https://img.shields.io/crates/l/pbr.svg)](https://github.com/a8m/pb/blob/master/LICENSE.md)

[![Docs](https://img.shields.io/badge/docs-reference-blue.svg)](https://a8m.github.io/pb/doc/pbr/index.html)

[![Build Status](https://travis-ci.org/a8m/pb.svg?branch=master)](https://travis-ci.org/a8m/pb)

[![Gitter](https://badges.gitter.im/a8m/pb.svg)](https://gitter.im/a8m/pb?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)

Console progress bar for Rust Inspired from [pb](http://github.com/cheggaaa/pb), support and 

tested on MacOS, Linux and Windows

![Screenshot](https://github.com/a8m/pb/blob/master/gif/rec_v3.gif)

[Documentation](https://a8m.github.io/pb/doc/pbr/index.html)

### Examples

1. simple example

```rust

use pbr::ProgressBar;

use std::thread;

fn main() {

    let count = 1000;

    let mut pb = ProgressBar::new(count);

    pb.format("╢▌▌░╟");

    for _ in 0..count {

        pb.inc();

        thread::sleep_ms(200);

    }

    pb.finish_print("done");

}

```

2. MultiBar example. see full example [here](https://github.com/a8m/pb/blob/master/examples/multi.rs)

```rust

use std::thread;

use pbr::MultiBar;

use std::time::Duration;

fn main() {

    let mut mb = MultiBar::new();

    let count = 100;

    mb.println("Application header:");

    let mut p1 = mb.create_bar(count);

    let _ = thread::spawn(move || {

        for _ in 0..count {

            p1.inc();

            thread::sleep(Duration::from_millis(100));

        }

        // notify the multibar that this bar finished.

        p1.finish();

    });

    mb.println("add a separator between the two bars");

    let mut p2 = mb.create_bar(count * 2);

    let _ = thread::spawn(move || {

        for _ in 0..count * 2 {

            p2.inc();

            thread::sleep(Duration::from_millis(100));

        }

        // notify the multibar that this bar finished.

        p2.finish();

    });

    // start listen to all bars changes.

    // this is a blocking operation, until all bars will finish.

    // to ignore blocking, you can run it in a different thread.

    mb.listen();

}

```

3. Broadcast writing (simple file copying)

```rust

#![feature(io)]

use std::io::copy;

use std::io::prelude::*;

use std::fs::File;

use pbr::{ProgressBar, Units};

fn main() {

    let mut file = File::open("/usr/share/dict/words").unwrap();

    let n_bytes = file.metadata().unwrap().len() as usize;

    let mut pb = ProgressBar::new(n_bytes);

    pb.set_units(Units::Bytes);

    let mut handle = File::create("copy-words").unwrap().broadcast(&mut pb);

    copy(&mut file, &mut handle).unwrap();

    pb.finish_print("done");

}

```

### License

MIT