4 releases

0.2.1 Jun 12, 2021
0.2.0 May 28, 2021
0.1.2 May 28, 2021
0.1.1 Dec 20, 2020
0.1.0 Dec 19, 2020

#72 in Command-line interface

Download history 62/week @ 2021-02-25 89/week @ 2021-03-04 63/week @ 2021-03-11 104/week @ 2021-03-18 176/week @ 2021-03-25 126/week @ 2021-04-01 48/week @ 2021-04-08 60/week @ 2021-04-15 40/week @ 2021-04-22 195/week @ 2021-04-29 57/week @ 2021-05-06 96/week @ 2021-05-13 80/week @ 2021-05-20 110/week @ 2021-05-27 119/week @ 2021-06-03 57/week @ 2021-06-10

420 downloads per month

MIT license

16KB
151 lines

linya

Workflow Status

Simple concurrent progress bars.

Features

  • Intuitive API.
  • First-class support for rayon, etc.
  • Efficient, allocation-free redraws.
  • Addition of new subbars on-the-fly.
  • Single-threaded multi-bars.
  • Light-weight, only a single dependency.

Usage

linya is designed around the multi-bar case, and unlike other progress bar libraries, has no separate type for individual bars. Instead, we use the Progress type, a "bar coordinator".

Multi Bars

To mutably access a Progress across threads it must be wrapped in the usual concurrent sharing types. With rayon specifically, only Mutex is necessary:

use std::sync::Mutex;
use linya::{Bar, Progress};
use rayon::prelude::*;

let progress = Mutex::new(Progress::new());

// `into_par_iter()` is from `rayon`, and lets us parallelize some
// operation over a collection "for free".
(0..10).into_par_iter().for_each(|n| {
  let bar: Bar = progress.lock().unwrap().bar(50, format!("Downloading {}", n));

  // ... Your logic ...

  // Increment the bar and draw it immediately.
  // This is likely called in some inner loop or other closure.
  progress.lock().unwrap().inc_and_draw(&bar, 10);
});

Notice that new bars are added on-the-fly from within forked threads. We call Progress::bar to obtain a new "bar handle", and then pass that handle back to the parent Progress when incrementing/drawing.

See Progress::inc_and_draw and Progress::set_and_draw to advance and render the bars.

Single Bars

Progress can also be used in a single-threaded context for individual bars. The usage is the same, except that no locking is required:

use linya::{Bar, Progress};

let mut progress = Progress::new();
let bar: Bar = progress.bar(50, "Downloading");

// Use in a loop, etc.
progress.set_and_draw(&bar, 10);

In this way, you could even have multi-bars in a single-threaded context.

Caveats

Some of the points below may be fixed in future releases.

  • Your terminal must support ANSI codes.
  • No dedicated render thread, to keep usage simple.
  • No bar templating, to avoid dependencies.
  • No other bar styling (yet).
  • No "rates", since rerenders are not time-based.
  • No bar clearing after completion.
  • No spinners, also due to no sense of time.
  • No dynamic resizing of bars if window size changes.

If you need more customizable progress bars and are willing to accept heavier dependencies, please consider indicatif.

Note also that using more than one Progress at the same time leads to unspecified behaviour.

Trivia

Linya is the Quenya word for "pool", as in a beautiful mountain pool.

Dependencies

~33KB