Struct gix_features::progress::ThroughputOnDrop

pub struct ThroughputOnDrop<T>(_, _)
where
         T: Progress;

Available on crate feature progress only.

Emit a message with throughput information when the instance is dropped.

Implementations

impl<T> ThroughputOnDrop<T>where T: Progress,

pub fn new(inner: T) -> ThroughputOnDrop<T>

Create a new instance by providing the inner Progress implementation.

Trait Implementations

impl<T> Drop for ThroughputOnDrop<T>where T: Progress,

fn drop(&mut self)

Executes the destructor for this type.

impl<T> Progress for ThroughputOnDrop<T>where T: Progress,

type SubProgress = <T as Progress>::SubProgress

The type of progress returned by add_child().

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

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

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

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

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

Initialize the Item for receiving progress information.

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.

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 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(&self, level: MessageLevel, message: impl Into<String>)

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

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

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

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 info(&self, message: impl Into<String>)

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

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

Create a message indicating the task is done successfully

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

Create a message indicating the task failed

fn show_throughput(&self, start: Instant)

A shorthand to print throughput information

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

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