Expand description
Progress bars, spinners, and status indicators.
This module provides:
- Progress bars with percentage, speed, ETA
- Spinners for indeterminate progress
- Status context for showing work in progress
track()helper for iterating with progress
Structs§
- BarColumn
- Renders the progress bar with distinct filled/unfilled characters.
- Download
Column - Renders a combined download display: “size @ speed” (e.g., “1.2 MB @ 500 KB/s”).
- Elapsed
Column - File
Size Column - Renders the completed file size (e.g., “1.2 MB”).
- MofN
Column - Percentage
Column - Renders the percentage complete (e.g. “50%”).
- Progress
- Multi-task progress display with optional Live-like lifecycle.
- Progress
Bar - A single progress bar configuration (Deprecated/Legacy support wrapper or helper). Kept for backward compat if anyone used it directly, but mainly used by BarColumn now.
- Spinner
- A spinner for indeterminate progress.
- Spinner
Column - Renders the spinner
- Status
- A status indicator that shows a spinner while work is happening.
- Task
- A task being tracked by the progress bar.
- Text
Column - Renders a static text string or text based on task properties.
- Time
Remaining Column - Renders time remaining
- Total
File Size Column - Renders the file size as “completed / total” (e.g., “1.2 MB / 5.0 MB”).
- Transfer
Speed Column - Renders transfer speed
Enums§
- Spinner
Style - Spinner animation style.
Traits§
- Progress
Column - A trait for rendering a column in a progress bar.
Functions§
- track
- Wrap an iterator with progress display.
- with_
status - Convenience function to run work with a status spinner.