Struct ProgressBar 

pub struct ProgressBar { /* private fields */ }

A progress bar. Mirrors rich.progress_bar.ProgressBar.

Implementations

impl ProgressBar

pub fn new(total: f64, completed: f64) -> Self

A bar of completed out of total, with upstream’s default bar.* styles.

pub fn indeterminate() -> Self

A bar with no total, which always pulses (upstream total=None).

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

Fix the bar width (otherwise it fills the available width).

pub fn style(self, style: impl Into<StyleType>) -> Self

The background style (upstream style, default bar.back).

pub fn complete_style(self, style: impl Into<StyleType>) -> Self

The completed-part style (upstream complete_style, default bar.complete).

pub fn finished_style(self, style: impl Into<StyleType>) -> Self

The style once finished (upstream finished_style, default bar.finished).

pub fn pulse_style(self, style: impl Into<StyleType>) -> Self

The pulse style (upstream pulse_style, default bar.pulse).

pub fn pulse(self, pulse: bool) -> Self

Render the pulse animation instead of the completion (upstream pulse).

pub fn animation_time(self, time: f64) -> Self

The time, in seconds, the pulse is drawn at (upstream animation_time). Without it the pulse follows a monotonic clock.

Trait Implementations

impl Renderable for ProgressBar

fn measure(&self, _console: &Console, options: &ConsoleOptions) -> Measurement

Port of ProgressBar.__rich_measure__: a fixed width measures exactly, otherwise the bar takes 4 cells up to the whole width.

fn rich_render( &self, console: &Console, options: &ConsoleOptions, ) -> Vec<Segment>

fn fit_to_measurement(&self) -> bool

Whether a top-level Console::print shrinks this renderable to its measured width. Upstream renders every top-level renderable at the full console width, so the default is false; an extension may opt in.