Skip to main content

ProgressBar

Struct ProgressBar 

Source
pub struct ProgressBar {
    pub total: Option<f64>,
    pub completed: f64,
    pub width: Option<usize>,
    pub complete_char: char,
    pub remaining_char: char,
    pub pulse: bool,
    pub complete_style: Style,
    pub remaining_style: Style,
    pub pulse_style: Style,
}
Expand description

A single progress bar.

Fields§

§total: Option<f64>

Total steps (None = indeterminate).

§completed: f64

Completed steps.

§width: Option<usize>

Width in characters.

§complete_char: char

Characters for completed portion.

§remaining_char: char

Characters for remaining portion.

§pulse: bool

Optional pulse style (for indeterminate).

§complete_style: Style

Style for completed portion.

§remaining_style: Style

Style for remaining portion.

§pulse_style: Style

Style for the pulse cursor.

Implementations§

Source§

impl ProgressBar

Source

pub fn new() -> Self

Create a new ProgressBar with default values (total=100, completed=0).

Source

pub fn total(self, total: f64) -> Self

Set total.

Source

pub fn completed(self, completed: f64) -> Self

Set completed.

Source

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

Set width.

Source

pub fn complete_style(self, style: Style) -> Self

Set complete style.

Source

pub fn remaining_style(self, style: Style) -> Self

Set remaining style.

Source

pub fn percentage(&self) -> f64

Get progress as a fraction (0.0–1.0).

Source

pub fn render(&self, width: usize) -> String

Render the bar to a string.

Trait Implementations§

Source§

impl Clone for ProgressBar

Source§

fn clone(&self) -> ProgressBar

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for ProgressBar

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for ProgressBar

Source§

fn default() -> Self

Returns the “default value” for a type. 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.