Trait gix_features::progress::RawProgress

source ·

pub trait RawProgress: Send + Sync {
Show 18 methods    // Required methods
    fn init(&mut self, max: Option<usize>, unit: Option<Unit>);
    fn set(&mut self, step: usize);
    fn step(&self) -> usize;
    fn inc_by(&mut self, step: usize);
    fn set_name(&mut self, name: String);
    fn name(&self) -> Option<String>;
    fn id(&self) -> [u8; 4];
    fn message(&self, level: MessageLevel, message: String);

    // Provided methods
    fn unit(&self) -> Option<Unit> { ... }
    fn max(&self) -> Option<usize> { ... }
    fn set_max(&mut self, _max: Option<usize>) -> Option<usize> { ... }
    fn inc(&mut self) { ... }
    fn counter(&self) -> Option<Arc<AtomicUsize>> { ... }
    fn info(&self, message: String) { ... }
    fn done(&self, message: String) { ... }
    fn fail(&self, message: String) { ... }
    fn show_throughput(&self, start: Instant) { ... }
    fn show_throughput_with(
        &self,
        start: Instant,
        step: usize,
        unit: Unit,
        level: MessageLevel
    ) { ... }
}

Available on crate feature progress only.

Expand description

A trait for describing non-hierarchical progress.

It differs by not being able to add child progress dynamically, but in turn is object safe. It’s recommended to use this trait whenever there is no need to add child progress, at the leaf of a computation.

Required Methods§

source

fn init(&mut self, max: Option<usize>, unit: Option<Unit>)

Initialize the Item for receiving progress information.

If max is Some(…), it will be treated as upper bound. When progress is set(…) it should not exceed the given maximum. If max is None, the progress is unbounded. Use this if the amount of work cannot accurately be determined in advance.

If unit is Some(…), it is used for display purposes only. See prodash::Unit for more information.

If both unit and max are None, the item will be reset to be equivalent to ‘uninitialized’.

If this method is never called, this Progress instance will serve as organizational unit, useful to add more structure to the progress tree (e.g. a headline).

Note that this method can be called multiple times, changing the bounded-ness and unit at will.

source

fn set(&mut self, step: usize)

Set the current progress to the given step. The cost of this call is negligible, making manual throttling not necessary.

Note: that this call has no effect unless init(…) was called before.

source

fn step(&self) -> usize

Returns the current step, as controlled by inc*(…) calls

source

fn inc_by(&mut self, step: usize)

Increment the current progress to the given step. The cost of this call is negligible, making manual throttling not necessary.

source

fn set_name(&mut self, name: String)

Set the name of the instance, altering the value given when crating it with add_child(…) The progress is allowed to discard it.

source

fn name(&self) -> Option<String>

Get the name of the instance as given when creating it with add_child(…) The progress is allowed to not be named, thus there is no guarantee that a previously set names ‘sticks’.

source