Struct progress_string::BarBuilder

pub struct BarBuilder { /* private fields */ }

Helper struct for building a progress bar.

Examples

use progress_string::BarBuilder;

let bar = BarBuilder::new()
                    .total(1000000)
                    .width(20)
                    .empty_char('0')
                    .full_char('X')
                    .include_percent()
                    .build();

the above would look something like this [XXXXXXXXXX0000000000] 50.00%

Implementations

impl BarBuilder

pub fn new() -> Self

Create a new BarBuilder.

pub fn total(self, total: usize) -> BarBuilder

Update the total (default 100).

Examples

use progress_string::BarBuilder;

let thousand = BarBuilder::new().total(1000).build();
// yields [█                                                 ]

pub fn width(self, width: usize) -> BarBuilder

Update the progress section’s width (default 50).

use progress_string::BarBuilder;

let bar = BarBuilder::new().width(10);
// yields [          ]

pub fn empty_char(self, character: char) -> BarBuilder

Update the character you want to use as an empty section of the progress bar (default ’ ’).

Examples

use progress_string::BarBuilder;

let zero_emp = BarBuilder::new().empty_char('0').build();
// yields
// [██████████00000000000]

pub fn full_char(self, character: char) -> BarBuilder

Update the character you want to use as a full section of the bar (default ‘█’).

Examples

use progress_string::BarBuilder;

let x_bar = BarBuilder::new().full_char('X').build();
// yields [XXXXXX      ]
let y_bar = BarBuilder::new().full_char('Y').build();
// yields [YYYYYY      ]

pub fn leading_char(self, character: impl Into<Option<char>>) -> BarBuilder

Update the character you want to use to lead the full section of the bar (defaults to the value of full_char if not provided).

Examples

use progress_string::BarBuilder;

let x_bar = BarBuilder::new()
                .full_char('X')
                .leading_char('}')
                .build();
// yields [XXXXXX}     ]
let y_bar = BarBuilder::new()
                .full_char('Y')
                .leading_char(')')
                .build();
// yields [YYYYYY)     ]

pub fn include_percent(self) -> BarBuilder

Update the bar to include the percent after the bar representation (default false).

Examples

use progress_string::BarBuilder;

let no_p = BarBuilder::new().include_percent().build();
// yields [██████████          ] 50.00%
let with_p = BarBuilder::new();
// yields [██████████          ]

pub fn include_numbers(self) -> BarBuilder

Update the bar to include the divison after the bar representation.

Examples

use progress_string::BarBuilder;

let mut no_n = BarBuilder::new().build();
no_n.replace(50);
// yields [██████████          ]
let mut with_n = BarBuilder::new().include_numbers().build();
with_n.replace(50)
// yields [██████████          ] 50/100

pub fn get_bar(self) -> Bar

👎Deprecated

deprecated please use build

pub fn build(self) -> Bar

Complete building your bar and return the updated struct.

Examples

use progress_string::BarBuilder;

let bar = BarBuilder::new().build();
// yields a default bar instance

Trait Implementations

impl Default for BarBuilder

fn default() -> Self

Returns the “default value” for a type.