Struct pit_wall::Progress

pub struct Progress {
    pub work_done: u64,
    /* private fields */
}

The struct holding the state and functions related to our progress.

Fields

work_done: u64

Implementations

impl Progress

pub fn new(name: &str, work_todo: u64) -> Self

Makes a progress object to track the work done.

Arguments

• name - A string slice to identify the job we’re tracking progress for.
• work_todo - The units of work that need to be done to reach 100% progress.

Examples

use pit_wall::Progress;
let mut progress = Progress::new("my job", 100);

pub fn inc_work_done(&mut self)

Increment work done by one unit.

use pit_wall::Progress;
let mut progress = Progress::new("my job", 100);
progress.inc_work_done();
assert_eq!(progress.work_done, 1);

pub fn inc_work_done_by(&mut self, units: u64)

Increment work done by a given amonut.

pub fn set_work_done(&mut self, units: u64)

Set work done.

pub fn get_progress_string(&self) -> String

Returns a formatted string giving a bunch of information on the current progress. You may want to log this periodically with whatever logging you have set up.