Struct ProgressWidget 

pub struct ProgressWidget<'a> { /* private fields */ }

A progress bar — the fill’s share of the track is the work done.

One instantiation is one bar. The ratio arrives through new; label and show_value compose the header above the track; and themed or style choose the colors.

Implementations

impl<'a> ProgressWidget<'a>

pub fn new(ratio: f64) -> Self

A bare bar filled by ratio, where 0.0 is empty and 1.0 is full.

Values outside 0.0..=1.0 are clamped: infinities pin to the nearer end, and a NaN that slipped out of a division counts as empty rather than printing itself as a percentage.

pub const fn label(self, label: &'a str) -> Self

Label the bar — the task’s name, above the fill, left-aligned. Pair it with show_value to complete the composition: name on the left, percentage on the right, bar underneath.

pub const fn show_value(self, show_value: bool) -> Self

Print the percentage right-aligned above the bar. Rounded to the nearest whole percent, 0% through 100%. The percentage and the fill round independently — ratatui’s gauge rounds its last cell in eighths — so at a width’s rounding edge the number can briefly sit one eighth of a cell away from the bar it describes. On a row too narrow for the number, what fits of it prints, digits first.

pub const fn themed(self, theme: &Theme) -> Self

Take colors from theme.

pub const fn style(self, style: ProgressStyle) -> Self

Use these exact colors, ignoring any theme.

pub const fn height(&self) -> u16

Rows the bar asks a layout for: two when a label or the percentage shows, one otherwise — an empty label still shows, since you asked for the row. Given less, the bar keeps the rows there are and the header is the first thing dropped; given more, the extra rows are left alone — a progress bar is one row of track, not a block meter.

Trait Implementations

impl<'a> Clone for ProgressWidget<'a>

fn clone(&self) -> ProgressWidget<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ProgressWidget<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq for ProgressWidget<'a>

fn eq(&self, other: &ProgressWidget<'a>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<'a> StructuralPartialEq for ProgressWidget<'a>

impl Widget for ProgressWidget<'_>

fn render(self, area: Rect, buf: &mut Buffer)

Draws the current state of the widget in the given buffer. That is the only method required to implement a custom widget.