Skip to main content

ProgressColumn

Enum ProgressColumn 

Source
pub enum ProgressColumn {
Show 14 variants Description, Text(String, Style), Bar, Percentage, TaskProgress { show_speed: bool, }, MofN, Download, BinaryDownload, TimeElapsed, TimeRemaining(TimeRemainingColumn), TransferSpeed, FileSize, TotalFileSize, Spinner(SpinnerColumn),
}
Expand description

A column in a Progress display. Mirrors upstream’s ProgressColumns.

Variants§

§

Description

The task description as console markup (TextColumn("[progress.description]{task.description}")).

§

Text(String, Style)

A static text cell with an explicit style (a simplified TextColumn).

§

Bar

The flexing progress bar (BarColumn).

§

Percentage

The completion percentage "{pct:>3}%" (default TaskProgressColumn).

§

TaskProgress

TaskProgressColumn(show_speed=…): the percentage, or for a task with no total and show_speed, the rate in it/s.

Fields

§show_speed: bool
§

MofN

"{completed}/{total}" (MofNCompleteColumn, progress.download).

§

Download

"{completed}/{total} {unit}" in shared SI byte units, e.g. 0.5/1.0 kB (DownloadColumn, progress.download).

§

BinaryDownload

As Download in binary units (DownloadColumn(binary_units=True)).

§

TimeElapsed

Elapsed time H:MM:SS (TimeElapsedColumn, progress.elapsed).

§

TimeRemaining(TimeRemainingColumn)

Estimated time remaining (TimeRemainingColumn, progress.remaining).

§

TransferSpeed

Data speed, e.g. 1.2 MB/s (TransferSpeedColumn, progress.data.speed).

§

FileSize

Completed size in decimal units (FileSizeColumn, progress.filesize).

§

TotalFileSize

Total size in decimal units (TotalFileSizeColumn, progress.filesize.total).

§

Spinner(SpinnerColumn)

An animated spinner (SpinnerColumn).

Implementations§

Source§

impl ProgressColumn

Source

pub fn time_remaining() -> Self

TimeRemainingColumn() with upstream’s defaults.

Source

pub fn spinner() -> Self

SpinnerColumn() with upstream’s defaults (dots, finished text " ").

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

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.