Struct pbr::ProgressBar [] [src]

pub struct ProgressBar<T: Write> {
    pub total: u64,
    pub is_finish: bool,
    pub is_multibar: bool,
    pub show_bar: bool,
    pub show_speed: bool,
    pub show_percent: bool,
    pub show_counter: bool,
    pub show_time_left: bool,
    pub show_tick: bool,
    pub show_message: bool,
    // some fields omitted
}

Fields

Methods

impl ProgressBar<Stdout>
[src]

Important traits for ProgressBar<T>
[src]

Create a new ProgressBar with default configuration.

Examples

use std::thread;
use pbr::{ProgressBar, Units};

let count = 1000;
let mut pb = ProgressBar::new(count);
pb.set_units(Units::Bytes);

for _ in 0..count {
   pb.inc();
   thread::sleep_ms(100);
}

impl<T: Write> ProgressBar<T>
[src]

Important traits for ProgressBar<T>
[src]

Create a new ProgressBar with default configuration but pass an arbitrary writer.

Examples

use std::thread;
use std::io::stderr;
use pbr::{ProgressBar, Units};

let count = 1000;
let mut pb = ProgressBar::on(stderr(), count);
pb.set_units(Units::Bytes);

for _ in 0..count {
   pb.inc();
   thread::sleep_ms(100);
}

[src]

Set units, default is simple numbers

Examples

use pbr::{ProgressBar, Units};

let n_bytes = 100;
let mut pb = ProgressBar::new(n_bytes);
pb.set_units(Units::Bytes);

[src]

Set custom format to the drawing bar, default is [=>-]

Examples

This example is not tested
let mut pb = ProgressBar::new(...);
pb.format("[=>_]");

[src]

Set message to display in the prefix, call with "" to stop printing a message.

All newlines are replaced with spaces.

Examples

This example is not tested
let mut pb = ProgressBar::new(20);

for x in 0..20 {
   match x {
      0 => pb.message("Doing 1st Quarter"),
      5 => pb.message("Doing 2nd Quarter"),
      10 => pb.message("Doing 3rd Quarter"),
      15 => pb.message("Doing 4th Quarter"),
   }
   pb.inc().
}

[src]

Set tick format for the progressBar, default is \|/-

Format is not limited to 4 characters, any string can be used as a tick format (the tick will successively take the value of each char but won't loop backwards).

Examples

This example is not tested
let mut pb = ProgressBar::new(...);
pb.tick_format("▀▐▄▌")

[src]

Set width, or None for default.

Examples

This example is not tested
let mut pb = ProgressBar::new(...);
pb.set_width(Some(80));

[src]

Set max refresh rate, above which the progress bar will not redraw, or None for none.

Examples

This example is not tested
let mut pb = ProgressBar::new(...);
pb.set_max_refresh_rate(Some(Duration::from_millis(100)));

[src]

Update progress bar even though no progress are made Useful to see if a program is bricked or just not doing any progress.

tick is not needed with add or inc as performed operation take place in draw function.

Examples

This example is not tested
let mut pb = ProgressBar::new(...);
pb.inc();
for _ in ... {
   ...do something
   pb.tick();
}
pb.finish();

[src]

Add to current value

Examples

use pbr::ProgressBar;

let mut pb = ProgressBar::new(10);
pb.add(5);
pb.finish();

[src]

Manually set the current value of the bar

Examples

use pbr::ProgressBar;
 
let mut pb = ProgressBar::new(10);
pb.set(8);
pb.finish();

[src]

Increment current value

[src]

Calling finish manually will set current to total and draw the last time

[src]

Call finish and write string s that will replace the progress bar.

[src]

Call finish and write string s below the progress bar.

If the ProgressBar is part of MultiBar instance, you should use finish_print to print message.

Trait Implementations

impl<T: Write> Write for ProgressBar<T>
[src]

[src]

Write a buffer into this object, returning how many bytes were written. Read more

[src]

Flush this output stream, ensuring that all intermediately buffered contents reach their destination. Read more

1.0.0
[src]

Attempts to write an entire buffer into this write. Read more

1.0.0
[src]

Writes a formatted string into this writer, returning any error encountered. Read more

1.0.0
[src]

Creates a "by reference" adaptor for this instance of Write. Read more

Auto Trait Implementations

impl<T> Send for ProgressBar<T> where
    T: Send

impl<T> Sync for ProgressBar<T> where
    T: Sync