Struct git_features::progress::ThroughputOnDrop

[+] Show declaration

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

Implementations

impl<T> ThroughputOnDrop<T> where
    T: Progress, [−]

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

Trait Implementations

impl<T> Drop for ThroughputOnDrop<T> where
    T: Progress, [+]

[+] Show hidden undocumented items

fn drop(&mut self)[−]

Executes the destructor for this type.

impl<T> Progress for ThroughputOnDrop<T> where
    T: Progress, [+]

[+] Show hidden undocumented items

type SubProgress = <T as Progress>::SubProgress

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

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

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: usize, unit: Unit)[−]

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