Struct progress_string::BarBuilder
[−]
[src]
pub struct BarBuilder { /* fields omitted */ }
Helper struct for building a progress bar
Examples
let bar = BarBuilder::new() .total(1000000) .width(20) .empty_char('0') .full_char('X') .include_percent() .get_bar();
the above would look something like this
[XXXXXXXXXX0000000000] 50.00%
Methods
impl BarBuilder
[src]
fn new() -> BarBuilder
[src]
Create a new Bar Builder
fn total(self, total: usize) -> BarBuilder
[src]
Add update the total (default 100) let thousand = BarBuilder::new().total(1000).get_bar();
Examples
thousand.update(200); //yeilds [█ ]
fn width(self, width: usize) -> BarBuilder
[src]
Update the progress section's width (default 50)
let bar = BarBuilder::new().width(10); ///yeids [ ]
fn empty_char(self, character: char) -> BarBuilder
[src]
Update the character you want to use as an empty section of the progress bar (default ' ')
Examples
let zero_emp = BarBuilder::new().empty_char('0').get_bar(); yeilds // [██████████00000000000]
fn full_char(self, character: char) -> BarBuilder
[src]
Update the character you want to sue as a full section of the bar (default '█')
Examples
let x_bar = BarBuilder::new().full_char('X').get_bar(); //yeilds [XXXXXX ] let y_bar = BarBuilder::new().full_char('Y').get_bar(); //yeilds [YYYYYY ]
fn include_percent(self) -> BarBuilder
[src]
Update the bar to include the percent after the bar representation (default false)
Examples
let no_p = BarBuilder::new().include_percent().get_bar(); //yeilds [██████████ ] 50.00% let with_p = BarBuilder::new() //yeilds [██████████ ]
fn include_numbers(self) -> BarBuilder
[src]
Update the bar to include the divison after the bar representation
Examples
let mut no_n = BarBuilder::new().get_bar(); no_n.replace(50); //yeilds [██████████ ] let mut with_n = BarBuilder::new().include_numbers().get_bar(); with_n.replace(50) //yeilds [██████████ ] 50/100
fn get_bar(self) -> Bar
[src]
Complete building your bar and return the updated struct
Examples
let bar = BarBuilder::new().get_bar(); //yeilds a default bar instance