Struct Bar

pub struct Bar { /* private fields */ }

A handle for users to control a progress bar created by Manager.

Implementations

impl Bar

pub fn inc(&self, n: u64)

Increment the progress bar by n. This makes an unforced draw.

pub fn set_pos(&self, pos: u64)

Set the position of the progress bar. This makes an unforced draw.

pub fn set_len(&self, len: u64)

Set the total length of the progress bar. This makes an unforced draw.

pub fn get_pos(&self) -> u64

Get the position of the progress bar.

When manager is dropped, this would return 0

pub fn get_len(&self) -> u64

Get the total length of the progress bar.

When manager is dropped, this would return 0

pub fn finish(&self)

Set the progress bar to the end, and force a draw.

pub fn finish_and_drop(self)

Set the progress bar to the end, force a draw, and remove the progress bar from the manager.

pub fn set_visible(&self, visible: bool)

Set the visibility of the progress bar. This makes an forced draw when visible actually changes.

pub fn is_visible(&self) -> bool

Get the visibility of the progress bar.

When manager is dropped, this would return false

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

Set the message of the progress bar. This makes an unforced draw.

pub fn set_template(&self, template: &str)

Set the template of the progress bar. This makes an unforced draw.

pub fn alive(&self) -> bool

Return whether the progress bar (the manager) is still alive.

When the manager is dropped, the progress bar would not be able to be interacted with.

Trait Implementations

impl Drop for Bar

fn drop(&mut self)

Drop the progress bar. This removes the progress bar from the manager and forces a draw.