Struct linya::Progress

pub struct Progress { /* private fields */ }

A progress bar “coordinator” to share between threads.

Implementations

impl Progress

pub fn new() -> Progress

Initialize a new progress bar coordinator.

pub fn with_capacity(capacity: usize) -> Progress

Like Progress::new but accepts a size hint to avoid reallocation as bar count grows.

pub fn bar<S: Into<String>>(&mut self, total: usize, label: S) -> Bar

Create a new progress bar with default styling and receive an owned handle to it.

Panics

Passing 0 to this function will cause a panic the first time a draw is attempted.

pub fn set(&mut self, bar: &Bar, value: usize)

Set a particular Bar’s progress value, but don’t draw it.

pub fn draw(&mut self, bar: &Bar)

Force the drawing of a particular Bar.

Note 1: Drawing will only occur if there is something meaningful to show. Namely, if the progress has advanced at least 1% since the last draw.

Note 2: If your program is not being run in a terminal, an initial empty bar will be printed but never refreshed.

pub fn set_and_draw(&mut self, bar: &Bar, value: usize)

Set a Bar’s value and immediately try to draw it.

pub fn inc(&mut self, bar: &Bar, value: usize)

Increment a given Bar’s progress, but don’t draw it.

pub fn inc_and_draw(&mut self, bar: &Bar, value: usize)

Increment a given Bar’s progress and immediately try to draw it.

pub fn is_done(&self, bar: &Bar) -> bool

Has the given bar completed?

pub fn cancel(&mut self, bar: Bar)

Cancel the given bar, say in the case of download failure, etc.

This fills the bar with the “cancel” character and consumes Bar ownership so that the bar cannot be manipulated again.

pub fn stderr(&mut self) -> impl Write + '_

Return a handle to write above all progress bars.

When the handle is dropped all progress bars are redrawn.

Examples

use std::fmt::Write;

writeln!(progress.stderr(), "Some log message");

Trait Implementations

impl Debug for Progress

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Progress

fn default() -> Progress

Returns the “default value” for a type.