Struct progress_string::BarBuilder [−][src]
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() .get_bar();
the above would look something like this
[XXXXXXXXXX0000000000] 50.00%
Implementations
impl BarBuilder
[src]
pub fn new() -> Self
[src]
Create a new BarBuilder
.
pub fn total(self, total: usize) -> BarBuilder
[src]
Update the total (default 100).
Examples
use progress_string::BarBuilder; let thousand = BarBuilder::new().total(1000).get_bar(); // yields [█ ]
pub fn width(self, width: usize) -> BarBuilder
[src]
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
[src]
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').get_bar(); // yields // [██████████00000000000]
pub fn full_char(self, character: char) -> BarBuilder
[src]
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').get_bar(); // yields [XXXXXX ] let y_bar = BarBuilder::new().full_char('Y').get_bar(); // yields [YYYYYY ]
pub fn include_percent(self) -> BarBuilder
[src]
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().get_bar(); // yields [██████████ ] 50.00% let with_p = BarBuilder::new(); // yields [██████████ ]
pub fn include_numbers(self) -> BarBuilder
[src]
Update the bar to include the divison after the bar representation.
Examples
use progress_string::BarBuilder; let mut no_n = BarBuilder::new().get_bar(); no_n.replace(50); // yields [██████████ ] let mut with_n = BarBuilder::new().include_numbers().get_bar(); with_n.replace(50) // yields [██████████ ] 50/100
pub fn get_bar(self) -> Bar
[src]
Complete building your bar and return the updated struct.
Examples
use progress_string::BarBuilder; let bar = BarBuilder::new().get_bar(); // yields a default bar instance
Trait Implementations
impl Default for BarBuilder
[src]
Auto Trait Implementations
impl RefUnwindSafe for BarBuilder
impl Send for BarBuilder
impl Sync for BarBuilder
impl Unpin for BarBuilder
impl UnwindSafe for BarBuilder
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,