Struct ProgressBar 

pub struct ProgressBar { /* private fields */ }

A thread safe, thread stable progress bar, abstracted for any frontend

Implementations

impl ProgressBar

pub fn custom<F>(&self, f: F)

where F: FnOnce() + Send + 'static,

Runs a custom closure for this progress bar.

Panics

Panics if the internal GLOBAL_SENDER thread cannot be communicated with. This usually signals critical failure somewhere

Notes

If the input closure panics, it will not kill the thread, it will instead log the error and return

pub fn flush(&self)

Waits until the flush is processed, allowing you to wait until all previous events have been processed

Panics

Panics if the internal GLOBAL_SENDER thread cannot be communicated with. This usually signals critical failure somewhere

pub fn get_max(&self) -> usize

Gets the max value of the internal ProgressHandle

Notes

While this will return the correct max value at time of call, In multi-threaded contexts, this max may have already changed by the time it has been used

pub fn get_value(&self) -> usize

Gets the value of the internal ProgressHandle

Notes

While this will return the correct value at time of call, In multi-threaded contexts, this value may have already changed by the time it has been used

pub fn increment(&self)

Increments the value of a progress bar by 1

Panics

Panics if the internal GLOBAL_SENDER thread cannot be communicated with. This usually signals critical failure somewhere

pub fn increment_and_run<P, Q>(&self, pre: Option<P>, post: Option<Q>)

where P: FnOnce() + Send + 'static, Q: FnOnce() + Send + 'static,

Increments the value of the progress bar by 1 and runs a pre-write and post-write closure

The pre closure, if some, will run before the value is incremented The post closure, if some, will run after the value is incremented, and before ProgressRenderer::on_update() method is run

Panics

Panics if the internal GLOBAL_SENDER thread cannot be communicated with. This usually signals critical failure somewhere

pub fn new( value: usize, max: usize, renderer: Arc<dyn ProgressRenderer>, ) -> Self

Creates a new progress bar instance using the renderer

This progress bar can safely be shared and updated between threads

pub fn set_max(&self, max: usize)

Sets the max-value of the progress bar

Panics

Panics if the internal GLOBAL_SENDER thread cannot be communicated with. This usually signals critical failure somewhere

pub fn set_max_and_run<P, Q>(&self, max: usize, pre: Option<P>, post: Option<Q>)

where P: FnOnce() + Send + 'static, Q: FnOnce() + Send + 'static,

Sets the max-value of the progress bar and runs a pre-write and post-write closure

The pre closure, if some, will run before the value is incremented The post closure, if some, will run after the value is incremented, and before ProgressRenderer::on_update() method is run

Panics

Panics if the internal GLOBAL_SENDER thread cannot be communicated with. This usually signals critical failure somewhere

Notes

If the any of the input closures panic, it will not kill the thread, it will instead log the error and ignore it

pub fn set_value(&self, value: usize)

Sets the value of the progress bar

Panics

Panics if the internal GLOBAL_SENDER thread cannot be communicated with. This usually signals critical failure somewhere

pub fn set_value_and_run<P, Q>( &self, value: usize, pre: Option<P>, post: Option<Q>, )

where P: FnOnce() + Send + 'static, Q: FnOnce() + Send + 'static,

Sets the value of the progress bar and runs a pre-write and post-write closure

The pre closure, if some, will run before the value is incremented The post closure, if some, will run after the value is incremented, and before ProgressRenderer::on_update() method is run

Panics

Panics if the internal GLOBAL_SENDER thread cannot be communicated with. This usually signals critical failure somewhere

Notes

If the any of the input closures panic, it will not kill the thread, it will instead log the error and ignore it

pub fn update(&self)

Forces the ProgressRenderer to upate with the new values

Panics

Panics if the progress bars handling thread cannot be communicated with.

pub fn is_alive(&self) -> bool

Checks if the the handling thread is alive by sending a check to it and seeing if it returns Ok

Notes

This function will correctly check if the handling thread is alive at the time of calling, but can not guarantee the thread will stay alive after calling or that it receives the check

pub fn set_label(&self, label: &str)

Calls the ProgressRenderer::set_label() function for the held ProgressRenderer

pub fn notify(&self, message: impl ToString)

Tells the handling thread to call the ProgressRenderer::on_notify() function for the held ProgressRenderer

Panics

Panics if the progress bars handling thread cannot be communicated with.

Trait Implementations

impl Clone for ProgressBar

fn clone(&self) -> ProgressBar

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.