Struct stati::bars::simple::SimpleBar

pub struct SimpleBar { /* private fields */ }

A simple progress bar implementation, based off that of the progress crates progresbar

Implementations

impl SimpleBar

pub fn new(name: impl ToString, hint: usize) -> Self

name: the name of the job

hint: hint for the maximum value this will reach

pub fn set_name(&mut self, job_name: String)

Trait Implementations

impl Clone for SimpleBar

fn clone(&self) -> SimpleBar

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SimpleBar

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

Formats the value using the given formatter.

impl Hash for SimpleBar

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl IsBar for SimpleBar

fn display(&mut self) -> String

Some implementation details:

starts with “\r” and has no end char

if it cannot get the real term size, uses 81 as the size

fn done(&mut self)

Finishes the Bar, allowing it to be finalized and dropped by the manager according to the close method returned by close_method. The bar should not be used after this is called.

fn is_done(&self) -> bool

Checks if the Bar is done (IsBar::done as been called)

fn close_method(&self) -> BarCloseMethod

Returns how the bar should be handled by the BarManager after done is called

impl IteratorProgress for SimpleBar

fn set_progress(&mut self, progress: usize)

Sets the current progress (number of items iterated through)

fn set_size_hint(&mut self, hint: usize)

sets a hint for the maximum value set_progress will ever reach