Struct Progress

pub struct Progress { /* private fields */ }

Tracks progress of a task.

There should be not more than a single instance started at a given point in time, it will mangle your terminal output.

Implementations

impl Progress

pub fn new<S: Into<String>>(caption: S, start: usize, end: usize) -> Self

pub fn new_with_width<S>( caption: S, start: usize, end: usize, width: u16, ) -> Self

where S: Into<String>,

pub fn current(&self) -> usize

Returns the current progress absolute value.

Example

use progress::Progress;
let p = Progress::default();
assert_eq!(0, p.current());

pub fn total(&self) -> usize

Returns the total value.

Example

use progress::Progress;
let p = Progress::default();
assert_eq!(100, p.total());

pub fn forward(&mut self, step: usize) -> &Self

Advances the Progress by a certain amount.

Examplw

use progress::Progress;
let mut p = Progress::default();
assert_eq!(0, p.current());
p.forward(10);
assert_eq!(10, p.current());
p += 20;
assert_eq!(30, p.current());

pub fn backward(&mut self, step: usize) -> &Self

Advances the Progress by a certain amount.

Examplw

use progress::Builder;
let mut p = Builder::new().set_start(30).build();
assert_eq!(30, p.current());
p.backward(10);
assert_eq!(20, p.current());
p -= 20;
assert_eq!(0, p.current());

pub fn increment(&mut self) -> &Self

Advances the Progress by exactly one.

pub fn decrement(&mut self) -> &Self

Does a step backwards at the Progress.

pub fn finished(&self) -> bool

Determines wheter a Progress has finished (reached the total) or not.

pub fn process(&self) -> u8

Returns the relative value of the Progress.

pub fn start(&mut self) -> &Self

Activates the Progress.

pub fn caption(&self) -> &String

Returns the current caption.

Trait Implementations

impl AddAssign<usize> for Progress

fn add_assign(&mut self, step: usize)

Performs the += operation.

impl Default for Progress

fn default() -> Progress

Returns the “default value” for a type.

impl SubAssign<usize> for Progress

fn sub_assign(&mut self, step: usize)

Performs the -= operation.