Struct `ProgressDrawTarget`

struct ProgressDrawTarget { ... }

Target for draw operations

This tells a ProgressBar or a MultiProgress object where to paint to. The draw target is a stateful wrapper over a drawing destination and internally optimizes how often the state is painted to the output device.

Implementations

`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.

Will panic if refresh_rate is 0.

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