Struct State

pub struct State { /* private fields */ }

Current state of Progress.

This is used with custom item and returned by Progress::state.

See custom item for an example.

Implementations

impl State

pub fn eta(&self) -> Option<Duration>

Returns estimated time remaining or None if estimate is not available.

Estimate is based on completed steps and time of latest completion.

Estimate is available if

• total is Some and
• at least one step and at most total steps have been completed and
• at least 100 ms has elapsed since Progress creation.

See custom item for an example.

pub fn percent(&self) -> Option<f64>

Returns percentual completion or None if total is None.

Returned value can be over 100 if position is incremented beyond total.

Examples

use ml_progress::progress;

let progress = progress!(10)?;
progress.inc(6);
assert_eq!(progress.state().lock().percent(), Some(60.0));

pub fn pos(&self) -> u64

Returns position.

Examples

use ml_progress::progress;

let progress = progress!(10)?;
progress.inc(6);
assert_eq!(progress.state().lock().pos(), 6);

pub fn speed(&self) -> Option<f64>

Returns speed in steps per second or None if speed is not available.

Speed is average from when Progress was created until latest inc.

Speed is available if

• at least one step has been completed and
• at least 100 ms has elapsed since Progress creation.

pub fn thousands_separator(&self) -> &str

Returns thousands separator.

Separator can be set with ProgressBuilder::thousands_separator, default is space.

Examples

use ml_progress::progress_builder;

let progress = progress_builder!().thousands_separator(",").build()?;
assert_eq!(progress.state().lock().thousands_separator(), ",");

pub fn total(&self) -> Option<u64>

Returns total.

Examples

use ml_progress::progress;

let progress = progress!(10)?;
assert_eq!(progress.state().lock().total(), Some(10));