Struct ProgressBar 

pub struct ProgressBar {
    pub timeout: Duration,
    pub update_interval: Duration,
    pub failed_str: String,
    pub done_str: String,
    pub show_result: bool,
}

A ProgressBar that can be rendered in a telegram message. This calls a long running async task and shows a progress bar while the task is running. The progress bar is updated every update_interval seconds. If the task completes before the timeout then the progress bar is replaced with a checkmark. If the task fails, then the progress bar is replaced with a cross.

Fields

timeout: Duration

The timeout for the progress bar. If the task completes before this timeout, then the progress bar is replaced with a checkmark.

update_interval: Duration

The update interval for the progress bar. The progress bar is updated every update_interval seconds.

failed_str: String

The string to show when the task fails.

done_str: String

The string to show when the task completes successfully.

show_result: bool

If true, then show the result of the task after the progress bar.

Implementations

impl ProgressBar

pub fn new() -> Self

Create a new progress bar.

pub fn with_timeout(self, timeout: Duration) -> Self

Set the timeout for the progress bar. If the task completes before this timeout, then the progress bar is replaced with a checkmark.

pub fn with_update_interval(self, update_interval: Duration) -> Self

Set the update interval for the progress bar. The progress bar is updated every update_interval seconds.

pub async fn start<F, R>(&self, e: &Event, f: F) -> Result<R>

where F: Future<Output = Result<R>> + Send + 'static, R: Default + Send + Sync + 'static,

Start the progress bar. This calls the async function f and shows a progress bar while the task is running. The progress bar is updated every update_interval seconds. If the task completes before the timeout then the progress bar is replaced with a checkmark. If the task fails, then the progress bar is replaced with a cross.

If show_result is true, then the result of the task is shown after the progress bar.

Returns the result of the task.

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.

impl Debug for ProgressBar

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ProgressBar

fn default() -> Self

Returns the “default value” for a type.