Struct BarBuilder

pub struct BarBuilder { /* private fields */ }

A builder that used for creating customize progress bar.

Examples

use std::thread;

extern crate progress;

fn main() {
    let mut bar = progress::BarBuilder::new()
        .left_cap("<")
        .right_cap(">")
        .empty_symbol("-")
        .filled_symbol("/")
        .build();

    bar.set_job_title("Meow...");

    for i in 0..11 {
        thread::sleep_ms(500);
        bar.reach_percent(i * 10);
    }
}

Implementations

impl BarBuilder

pub fn new() -> BarBuilder

Create a new progress bar builder.

pub fn left_cap(&mut self, symbol: &str) -> &mut BarBuilder

Set desired symbol used as left cap

[=========-] 90%
^

pub fn right_cap(&mut self, symbol: &str) -> &mut BarBuilder

Set desired symbol used as right cap

[=========-] 90%
           ^

pub fn filled_symbol(&mut self, symbol: &str) -> &mut BarBuilder

Set desired symbol used as filled bar

[=========-] 90%
 ^^^^^^^^^

pub fn empty_symbol(&mut self, symbol: &str) -> &mut BarBuilder

Set desired symbol used as empty bar

[=========-] 90%
          ^

pub fn build(&mut self) -> Bar

Build progress bar according to previous configurations.