Struct prodash::progress::Discard

pub struct Discard;

An implementation of Progress which discards all calls.

Trait Implementations

impl Progress for Discard

type SubProgress = Discard

The type of progress returned by add_child().

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

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

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

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

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

Returns the (cloned) unit associated with this Progress

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

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

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(&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: Step, unit: Unit)

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