ProgressBar

Struct ProgressBar 

Source
pub struct ProgressBar {
    pub total_steps: usize,
    pub current: usize,
    pub label: Option<String>,
    pub style: ProgressStyle,
    pub total_bytes: Option<u64>,
    pub bytes_processed: u64,
    /* private fields */
}
Expand description

Struct-based progress bar

Fields§

§total_steps: usize§current: usize§label: Option<String>§style: ProgressStyle§total_bytes: Option<u64>§bytes_processed: u64

Implementations§

Source§

impl ProgressBar

Source

pub fn new(total_steps: usize, style: ProgressStyle) -> Self

Source

pub fn set_label(&mut self, label: &str)

Source

pub fn set_progress(&mut self, value: usize)

Source

pub fn tick(&mut self)

Source

pub fn set_bytes_total(&mut self, total: u64)

Set total bytes (enables byte-based progress). You may update processed bytes independently.

Source

pub fn set_bytes_processed(&mut self, processed: u64)

Set processed bytes; will render percent, rate, and ETA when total is known.

Source

pub fn set_bytes(&mut self, total: u64, processed: u64)

Convenience to set both total and processed bytes in one call.

Source

pub fn pause(&mut self)

Pause updates by tick(); direct set_ calls will still render.

Source

pub fn resume(&mut self)

Resume updates.

Source

pub fn start_auto(&mut self, duration_ms: u64)

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.