Struct prog_rs::progress::Progress

pub struct Progress { /* private fields */ }

A generic progress bar that needs to be manually updated.

Example

let mut progress = Progress::new()
    .with_bar_width(30)
    .with_extra_infos("Hello, World!")
    .with_refresh_delay(Duration::from_millis(100))
    .with_output_stream(OutputStream::StdErr);

for i in 0..10_000 {
    progress.update(i as f32 / 10_000.).unwrap();
    progress = progress
        .with_extra_infos(format!("Hello, World! ({}/10000)", i + 1));
    sleep(Duration::from_nanos(110));
}

progress.finished().ok();

Implementations

impl<'a> Progress

pub fn new() -> Self

Create a new progress bar with default display settings.

pub fn with_bar_position(self, bar_position: BarPosition) -> Self

Change the style of the bar disposition.

pub fn with_bar_width(self, bar_width: usize) -> Self

Change the width of the progress bar.

pub fn with_display_width(self, display_width: usize) -> Self

Change the width of the text the displayed informations should try to fit in. The terminal width will be detected by default.

pub fn with_extra_infos<S>(self, extra_infos: S) -> Self where
    S: Into<String>, 

Specify extra informations to display.

pub fn with_output_stream(self, output_stream: OutputStream) -> Self

Change the output stream the progress bar is displayed in. By default standart output is used.

pub fn with_prefix<S>(self, prefix: S) -> Self where
    S: Into<String>, 

Change the text displayed in front of progress informations.

Example

use prog_rs::prelude::*;
use prog_rs::Progress;

let progress = Progress::new().with_prefix("Computing something ...");

for i in (0..1000) {
    progress.update(i as f32 / 1000.)?;
    do_something(i);
}

progress.finish()?;

pub fn with_refresh_delay(self, refresh_delay: Duration) -> Self

Change the minimum delay between two display updates.

pub fn with_shape_body(self, shape_body: char) -> Self

Change the character used to draw the body of the progress bar.

pub fn with_shape_head(self, shape_head: char) -> Self

Change the character used to draw the head of the progress bar.

pub fn with_shape_void(self, shape_void: char) -> Self

Change the character used to draw the background of the progress bar.

pub fn set_extra_infos<S>(&mut self, extra_infos: S) where
    S: Into<String>, 

Update extra informations displayed next to the progress bar.

pub fn need_refresh(&self) -> bool

Check if the timer specified by with_refresh_delay has decayed.

pub fn update(&mut self, progress: f32) -> Result<()>

Redraw the progress bar if the timer has decayed.

pub fn finished(&mut self) -> Result<()>

Redraw the progress bar for the last time.

Trait Implementations

impl Clone for Progress

fn clone(&self) -> Progress

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Progress

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

Formats the value using the given formatter.

impl<'a> Default for Progress

fn default() -> Self

Returns the “default value” for a type.