ProgressBar | struct ProgressBar | Thread-safe progress bar handle. | Progress Bars |
ProgressBarBuilder | struct ProgressBarBuilder | Builder for length, style, target, template, and throttling. | Progress Bars |
ProgressBar::new | fn new(len: u64) -> ProgressBar | Creates a measured bar. | Progress Bars |
ProgressBar::new_spinner | fn new_spinner() -> ProgressBar | Creates an indeterminate bar. | Spinners |
ProgressBar::hidden | fn hidden() -> ProgressBar | Creates a silent bar for tests. | Advanced |
ProgressBar::with_draw_target | fn with_draw_target(len, target) -> ProgressBar | Uses a custom draw target. | Advanced |
ProgressBar::with_style | fn with_style(len, style) -> ProgressBar | Creates a bar with a custom style. | Styling |
ProgressBar::with_template | fn with_template(len, template) -> Result<ProgressBar, TemplateError> | Creates a bar from a custom template. | Styling |
ProgressBar::builder | fn builder() -> ProgressBarBuilder | Starts builder configuration. | Progress Bars |
ProgressBarBuilder::template | fn template(self, template) -> Result<Self, TemplateError> | Sets a custom template while building. | Styling |
inc / inc_by | fn inc(&self, delta: u64) | Advances position. | Progress Bars |
set_position | fn set_position(&self, pos: u64) | Sets absolute position. | Progress Bars |
set_length | fn set_length(&self, len: u64) | Sets total length. | Progress Bars |
set_length_unknown | fn set_length_unknown(&self) | Clears the known total. | Progress Bars |
set_message | fn set_message(&self, msg) | Sets {msg}. | Styling |
set_prefix | fn set_prefix(&self, prefix) | Sets {prefix}. | Styling |
set_postfix | fn set_postfix(&self, postfix) | Sets {postfix}. | Styling |
tick | fn tick(&self) | Advances spinner frame. | Spinners |
finish | fn finish(&self) | Completes the bar. | Progress Bars |
finish_with_message | fn finish_with_message(&self, msg) | Completes with final message. | Progress Bars |
finish_with_symbol | fn finish_with_symbol(&self, symbol, msg) | Completes with a fixed prefix marker. | Progress Bars |
finish_and_clear | fn finish_and_clear(&self) | Completes and clears output. | Progress Bars |
abandon | fn abandon(&self) | Stops without finished state. | Progress Bars |
reset | fn reset(&self) | Reuses the bar from zero. | Progress Bars |
set_style | fn set_style(&self, style) | Replaces visual style. | Styling |
set_template | fn set_template(&self, template) -> Result<(), TemplateError> | Replaces style from a template. | Styling |
set_draw_delta | fn set_draw_delta(&self, delta) | Redraws after enough progress. | Advanced |
set_draw_rate | fn set_draw_rate(&self, rate) | Caps redraws per second. | Advanced |
enable_steady_tick | fn enable_steady_tick(&self, interval) | Starts background ticking. | Spinners |
println | fn println(&self, msg: &str) | Prints above the bar. | Progress Bars |
wrap_iter | fn wrap_iter<I>(&self, iter: I) | Uses a bar for an iterator. | Examples |
fraction | fn fraction(&self) -> f64 | Returns completion ratio. | Progress Bars |
percent | fn percent(&self) -> f64 | Returns completion percent. | Progress Bars |
remaining | fn remaining(&self) -> Option<u64> | Returns remaining work. | Progress Bars |
is_finished | fn is_finished(&self) -> bool | Returns completion state. | Progress Bars |
is_abandoned | fn is_abandoned(&self) -> bool | Returns abandonment state. | Progress Bars |
Spinner | struct Spinner | Ergonomic spinner wrapper. | Spinners |
Spinner::success | fn success(&self, msg) | Stops with a success marker. | Spinners |
Spinner::failure | fn failure(&self, msg) | Stops with a failure marker. | Spinners |
Spinner::warning | fn warning(&self, msg) | Stops with a warning marker. | Spinners |
Spinner::info | fn info(&self, msg) | Stops with an informational marker. | Spinners |
MultiProgress | struct MultiProgress | Shared block for many bars. | Multi Progress |
ProgressStyle | struct ProgressStyle | Template, chars, colors, keys. | Styling |
ProgressChars | struct ProgressChars | Reusable fill, head, and empty characters. | Styling |
Theme | enum Theme | Built-in style presets. | Themes |
Color | enum Color | ANSI color value. | Styling |
ColorSpec | struct ColorSpec | ANSI text attributes. | Styling |
DrawTarget | enum DrawTarget | Stdout, stderr, hidden, or writer. | Advanced |
terminal::detect::terminal_width_for_fd | fn terminal_width_for_fd(fd: i32) -> usize | Detects width for stdout/stderr with fallback. | Advanced |
terminal::detect::terminal_height_for_fd | fn terminal_height_for_fd(fd: i32) -> usize | Detects height for stdout/stderr with fallback. | Advanced |
terminal::detect::supports_interactive_output | fn supports_interactive_output(fd: i32) -> bool | Checks interactive cursor-update support for a stream. | Advanced |
ProgressIterator | trait ProgressIterator | Adds .progress() methods. | Examples |
format_bytes | fn format_bytes(u64) -> String | Human byte count. | Styling |
format_duration | fn format_duration(Duration) -> String | Human duration. | Styling |