Struct ProgressDrawTarget

impl ProgressDrawTarget

fn stdout() -> Self

Draw to a buffered stdout terminal at a max of 20 times a second.

For more information see ProgressDrawTarget::term.

fn stderr() -> Self

Draw to a buffered stderr terminal at a max of 20 times a second.

This is the default draw target for progress bars. For more information see ProgressDrawTarget::term.

fn stdout_with_hz(refresh_rate: u8) -> Self

Draw to a buffered stdout terminal at a max of refresh_rate times a second.

For more information see ProgressDrawTarget::term.

fn stderr_with_hz(refresh_rate: u8) -> Self

Draw to a buffered stderr terminal at a max of refresh_rate times a second.

For more information see ProgressDrawTarget::term.

fn term(term: Term, refresh_rate: u8) -> Self

Draw to a terminal, with a specific refresh rate.

Progress bars are by default drawn to terminals however if the terminal is not user attended the entire progress bar will be hidden. This is done so that piping to a file will not produce useless escape codes in that file.

Progress bars will also be hidden if TERM is unset/dumb.

Will panic if refresh_rate is 0.

fn term_like(term_like: Box<dyn TermLike>) -> Self

Draw to a boxed object that implements the TermLike trait.

Warning: unlike stdout(), stderr() and term(), this method does not set a default refresh rate. For most uses, consider using term_like_with_hz() instead.

(indicatif defaults to a refresh rate of 20 times per second in other methods.)

fn term_like_with_hz(term_like: Box<dyn TermLike>, refresh_rate: u8) -> Self

Draw to a boxed object that implements the TermLike trait, with a specific refresh rate.

fn hidden() -> Self

A hidden draw target.

This forces a progress bar to be not rendered at all.

fn is_hidden(&self) -> bool

Returns true if the draw target is hidden.

This is internally used in progress bars to figure out if overhead from drawing can be prevented.