Skip to main content

CliProgressRenderer

Struct CliProgressRenderer 

Source
pub struct CliProgressRenderer { /* private fields */ }
Expand description

A default implementation of a ProgressRenderer meant for CLI applications

Implementations§

Source§

impl CliProgressRenderer

Source

pub fn new(bar_width: usize) -> CliProgressRenderer

Source

pub fn print_above(&self, message: Arguments<'_>)

Prints text above the progress bar. Use this instead of println!() when a bar is running

Source

pub fn set_suffix(&self, suffix: impl AsRef<str>)

Sets the suffix of the progress bar for when it next updates

Trait Implementations§

Source§

impl ProgressRenderer for CliProgressRenderer

Source§

fn on_start(&self, value: usize, max: usize)

Called when the crate::ProgressBar which holds the instance of Self is spawned
Source§

fn on_update(&self, value: usize, max: usize)

Called when the crate::ProgressBar which holds the instance of Self is updated
Source§

fn on_finish(&self)

Called when the crate::ProgressBar which holds the instance of Self is dropped Read more
Source§

fn on_notify(&self, msg: String)

Generic notification. Can be sent from anything with access to the crate::ProgressBar that holds the instance of Self Read more
Source§

fn set_label(&self, msg: &str)

Sets the label of Self. Can be sent from anything with access to the crate::ProgressBar that holds the instance of Self Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.