Trait Progress

pub trait Progress: Send {
    type SubProgress: Progress;

    // Required methods
    fn add_child(&mut self, name: impl Into<String>) -> Self::SubProgress;
    fn add_child_with_id(
        &mut self,
        name: impl Into<String>,
        id: [u8; 4],
    ) -> Self::SubProgress;
    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: impl Into<String>);
    fn name(&self) -> Option<String>;
    fn id(&self) -> [u8; 4];
    fn message(&mut self, level: MessageLevel, message: impl Into<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(&mut self, message: impl Into<String>) { ... }
    fn done(&mut self, message: impl Into<String>) { ... }
    fn fail(&mut self, message: impl Into<String>) { ... }
    fn show_throughput(&mut self, start: Instant) { ... }
    fn show_throughput_with(
        &mut self,
        start: Instant,
        step: usize,
        unit: Unit,
        level: MessageLevel,
    ) { ... }
}

Available on crate feature progress only.

A trait for describing hierarchical process.

Required Associated Types

type SubProgress: Progress

The type of progress returned by add_child().

Required Methods

fn add_child(&mut self, name: impl Into<String>) -> Self::SubProgress

Adds a new child, whose parent is this instance, with the given name.

This will make the child progress to appear contained in the parent progress. Note that such progress does not have a stable identifier, which can be added with add_child_with_id() if desired.

fn add_child_with_id( &mut self, name: impl Into<String>, id: [u8; 4], ) -> Self::SubProgress

Adds a new child, whose parent is this instance, with the given name and id.

This will make the child progress to appear contained in the parent progress, and it can be identified using id.

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.

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.

fn step(&self) -> usize

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

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.

fn set_name(&mut self, name: impl Into<String>)

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

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’.

fn id(&self) -> [u8; 4]

Get a stable identifier for the progress instance. Note that it could be unknown.

fn message(&mut self, level: MessageLevel, message: impl Into<String>)

Create a message of the given level and store it with the progress tree.

Use this to provide additional,human-readable information about the progress made, including indicating success or failure.

Provided Methods

fn unit(&self) -> Option<Unit>

Returns the (cloned) unit associated with this Progress

fn max(&self) -> Option<usize>

Returns the maximum about of items we expect, as provided with the init(…) call

fn set_max(&mut self, _max: Option<usize>) -> Option<usize>

Set the maximum value to max and return the old maximum value.

fn inc(&mut self)

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

fn counter(&self) -> Option<Arc<AtomicUsize>>

If available, return an atomic counter for direct access to the underlying state.

This is useful if multiple threads want to access the same progress, without the need for provide each their own progress and aggregating the result.

fn info(&mut self, message: impl Into<String>)

Create a message providing additional information about the progress thus far.

fn done(&mut self, message: impl Into<String>)

Create a message indicating the task is done successfully

fn fail(&mut self, message: impl Into<String>)

Create a message indicating the task failed

fn show_throughput(&mut self, start: Instant)

A shorthand to print throughput information

fn show_throughput_with( &mut self, start: Instant, step: usize, unit: Unit, level: MessageLevel, )

A shorthand to print throughput information, with the given step and unit, and message level.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl<'a, T> Progress for &'a mut T

where T: Progress,

type SubProgress = <T as Progress>::SubProgress

fn add_child( &mut self, name: impl Into<String>, ) -> <&'a mut T as Progress>::SubProgress

fn add_child_with_id( &mut self, name: impl Into<String>, id: [u8; 4], ) -> <&'a mut T as Progress>::SubProgress

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

fn set(&mut self, step: usize)

fn unit(&self) -> Option<Unit>

fn max(&self) -> Option<usize>

fn set_max(&mut self, max: Option<usize>) -> Option<usize>

fn step(&self) -> usize

fn inc_by(&mut self, step: usize)

fn inc(&mut self)

fn set_name(&mut self, name: impl Into<String>)

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

fn id(&self) -> [u8; 4]

fn message(&mut self, level: MessageLevel, message: impl Into<String>)

fn counter(&self) -> Option<Arc<AtomicUsize>>

fn info(&mut self, message: impl Into<String>)

fn done(&mut self, message: impl Into<String>)

fn fail(&mut self, message: impl Into<String>)

fn show_throughput(&mut self, start: Instant)

fn show_throughput_with( &mut self, start: Instant, step: usize, unit: Unit, level: MessageLevel, )

Implementors

impl Progress for Discard

type SubProgress = Discard

impl<L, R> Progress for Either<L, R>

where L: Progress, R: Progress,

type SubProgress = Either<<L as Progress>::SubProgress, <R as Progress>::SubProgress>

impl<T> Progress for DoOrDiscard<T>

where T: Progress,

type SubProgress = DoOrDiscard<<T as Progress>::SubProgress>

impl<T> Progress for ThroughputOnDrop<T>

where T: Progress,

type SubProgress = <T as Progress>::SubProgress