Struct fclones::progress::FastProgressBar

pub struct FastProgressBar { /* fields omitted */ }

A wrapper over indicatif::ProgressBar that makes updating its progress lockless. Unfortunately indicatif::ProgressBar wraps state in a Mutex, so updates are slow and can become a bottleneck in multithreaded context. This wrapper uses atomic_counter::RelaxedCounter to keep shared state without ever blocking writers. That state is copied repeatedly by a background thread to an underlying ProgressBar at a low rate.

Implementations

impl FastProgressBar

pub fn wrap(progress_bar: ProgressBar) -> FastProgressBar

Wrap an existing ProgressBar and start the background updater-thread. The thread periodically copies the FastProgressBar position into the wrapped ProgressBar instance.

pub fn new_spinner(msg: &str) -> FastProgressBar

Create a new preconfigured animated spinner with given message.

pub fn new_progress_bar(msg: &str, len: u64) -> FastProgressBar

Create a new preconfigured progress bar with given message.

pub fn new_bytes_progress_bar(msg: &str, len: u64) -> FastProgressBar

Create a new preconfigured progress bar with given message. Displays progress in bytes.

pub fn new_hidden() -> FastProgressBar

Creates a new invisible progress bar. This is useful when you need to disable progress bar, but you need to pass an instance of a ProgressBar to something that expects it.

pub fn set_draw_target(&self, target: ProgressDrawTarget)

pub fn is_visible(&self) -> bool

pub fn println<I: Into<String>>(&self, msg: I)

pub fn tick(&self)

pub fn inc(&self, delta: usize)

pub fn position(&self) -> usize

pub fn last_displayed_position(&self) -> u64

pub fn finish(&self)

pub fn finish_and_clear(&self)

pub fn finish_with_msg(&self, message: &str)

pub fn abandon(&self)

pub fn is_finished(&self) -> bool

Trait Implementations

impl Drop for FastProgressBar

fn drop(&mut self)

Executes the destructor for this type.