Struct prodash::progress::Log

pub struct Log { /* private fields */ }

A NestedProgress implementation which displays progress as it happens without the use of a renderer.

Note that this incurs considerable performance cost as each progress calls ends up getting the system time to see if progress information should actually be emitted.

Implementations

impl Log

pub fn new(name: impl Into<String>, max_level: Option<usize>) -> Self

Create a new instance from name while displaying progress information only up to max_level.

Trait Implementations

impl Count for Log

fn set(&self, step: Step)

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(&self, step: Step)

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

fn counter(&self) -> StepShared

Return an atomic counter for direct access to the underlying state.

fn inc(&self)

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

impl NestedProgress for Log

type SubProgress = Log

The type of progress returned by [add_child()][Progress::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 add_child_with_id( &mut self, name: impl Into<String>, id: Id ) -> Self::SubProgress

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

impl Progress for Log

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

Initialize the Item for receiving progress information.

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 set_max(&mut self, max: Option<Step>) -> Option<Step>

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

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.

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) -> Id

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

fn message(&self, level: MessageLevel, message: String)

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

fn info(&self, message: String)

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

fn done(&self, message: String)

Create a message indicating the task is done successfully

fn fail(&self, message: 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: Step, unit: Unit, level: MessageLevel )

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