Struct git_features::progress::DoOrDiscard

[+] Show declaration

pub struct DoOrDiscard<T>(_);

[−] Expand description

An implementation of Progress which can be created easily from Option<impl Progress>.

Implementations

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

pub fn into_inner(self) -> Option<T>[−]

Obtain either the original Progress implementation or None.

pub fn take(&mut self) -> Option<T>[−]

Take out the implementation of Progress and replace it with Discard.

Trait Implementations

impl<T> From<Option<T>> for DoOrDiscard<T> where
    T: Progress, [+]

[+] Show hidden undocumented items

pub fn from(p: Option<T>) -> DoOrDiscard<T>[−]

Performs the conversion.

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

[+] Show hidden undocumented items

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

The type of progress returned by add_child().

pub fn add_child(
    &mut self,
    name: impl Into<String>
) -> <DoOrDiscard<T> as Progress>::SubProgress[−]

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

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

Initialize the Item for receiving progress information.

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

pub fn unit(&self) -> Option<Unit>[−]

Returns the (cloned) unit associated with this Progress

pub fn max(&self) -> Option<usize>[−]

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

pub fn step(&self) -> usize[−]

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

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

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

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

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

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

pub fn inc(&mut self)[−]

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

pub fn info(&mut self, message: impl Into<String>)[−]

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

pub fn done(&mut self, message: impl Into<String>)[−]

Create a message indicating the task is done successfully

pub fn fail(&mut self, message: impl Into<String>)[−]

Create a message indicating the task failed

pub fn show_throughput(&mut self, start: Instant)[−]

A shorthand to print throughput information

pub fn show_throughput_with(&mut self, start: Instant, step: usize, unit: Unit)[−]

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