Skip to main content

BarStyle

Enum BarStyle 

Source
pub enum BarStyle {
    Main,
    Minified,
    Steps,
    Spinner,
    ClearOnFinish,
}
Expand description

The look & feel of a GradientProgressBar.

This is the layout, independent of the gradient. Pick a layout here, and pair it with any Gradient (or none, to keep the classic two-tone wide_bar).

Variants§

§

Main

The flagship layout: spinner + message + elapsed + wide bar with bytes/total + percent + ETA. Best suited to a byte-based workload.

§

Minified

Compact single-line layout, for tight output or secondary bars.

§

Steps

For chunk / step based workloads (e.g. multithreaded splitting). Shows pos/len as chunks.

§

Spinner

Indeterminate progress (no known total): animates a spinner + message.

§

ClearOnFinish

Like BarStyle::Main, but cleared from the terminal once it finishes (pair with crate::GradientProgressBar::finish_and_clear).

Implementations§

Source§

impl BarStyle

Source

pub const DEFAULT_GRADIENT_WIDTH: usize = 25

Default bar width (in cells) used when rendering a gradient.

Modified to 25 instead of 30 because indicatif was wrapping the lines.

Source

pub fn to_progress_style( &self, gradient: Option<Gradient>, width: usize, unit: Option<String>, ) -> ProgressStyle

Build the indicatif::ProgressStyle for this layout.

When gradient is Some, the bar is rendered by Gradient (true-color multi-stop). When None, the classic two-tone {wide_bar:.cyan/blue} is used. width controls the gradient bar’s column count.

Trait Implementations§

Source§

impl Clone for BarStyle

Source§

fn clone(&self) -> Self

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 Copy for BarStyle

Source§

impl Debug for BarStyle

Source§

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

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

impl Default for BarStyle

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for BarStyle

Source§

impl Hash for BarStyle

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for BarStyle

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for BarStyle

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 = !

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

fn try_from(value: U) -> Result<T, !>

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.