Enum ProgressColumn 

pub enum ProgressColumn {
    Description,
    Text(String, Style),
    TextFormat(TextColumn),
    Renderable(Arc<dyn Renderable + Send + Sync>),
    Bar,
    Percentage,
    TaskProgress {
        show_speed: bool,
    },
    MofN,
    Download,
    BinaryDownload,
    TimeElapsed,
    TimeRemaining(TimeRemainingColumn),
    TransferSpeed,
    FileSize,
    TotalFileSize,
    Spinner(SpinnerColumn),
    BarWith(BarColumn),
    WithTableColumn(Box<ProgressColumn>, ColumnOptions),
}

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).

TextFormat(TextColumn)

A text cell formatted from the task (TextColumn).

Renderable(Arc<dyn Renderable + Send + Sync>)

The same renderable in every row (RenderableColumn). It may span several lines; the row grows to fit it.

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).

BarWith(BarColumn)

A bar with its width and styles set (BarColumn(bar_width=…, style=…)). A bar_width of None lets the bar fill its column.

WithTableColumn(Box<ProgressColumn>, ColumnOptions)

A column with explicit table-column options (upstream’s table_column= argument). See ProgressColumn::with_table_column.

Implementations

impl ProgressColumn

pub fn time_remaining() -> Self

TimeRemainingColumn() with upstream’s defaults.

pub fn spinner() -> Self

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

pub fn with_table_column(self, options: ColumnOptions) -> Self

This column with explicit table-column options, as upstream’s table_column=Column(...) argument sets them: width, ratio, justify, wrapping and style of the grid column.