Struct git_features::progress::unit::Human

pub struct Human {
    pub name: &'static str,
    pub formatter: Formatter,
}

Available on crate feature progress only.

A helper for formatting numbers in a format easily read by humans in renderers, as in 2.54 million objects

Fields

name: &'static str

The name of the represented unit, like ‘items’ or ‘objects’.

formatter: Formatter

The formatter to format the actual numbers.

Implementations

impl Human

pub fn new(formatter: Formatter, name: &'static str) -> Human

Available on crate feature unit-human only.

A convenience method to create a new new instance and its formatter and name fields.

Trait Implementations

impl Debug for Human

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl DisplayValue for Human

fn display_current_value(
    &self,
    w: &mut dyn Write,
    value: usize,
    _upper: Option<usize>
) -> Result<(), Error>

Display the absolute value representing the current progress of an operation and write it to w.

fn display_upper_bound(
    &self,
    w: &mut dyn Write,
    upper_bound: usize,
    _value: usize
) -> Result<(), Error>

Emit the upper_bound to w.

fn display_unit(&self, w: &mut dyn Write, _value: usize) -> Result<(), Error>

Emit the unit of value to w.

fn separator(
    &self,
    w: &mut dyn Write,
    _value: usize,
    _upper: Option<usize>
) -> Result<(), Error>

Emit a token to separate two values.

fn display_percentage(
    &self,
    w: &mut dyn Write,
    percentage: f64
) -> Result<(), Error>

Emit percentage to w.

fn display_throughput(
    &self,
    w: &mut dyn Write,
    throughput: &Throughput
) -> Result<(), Error>

Emit the throughput of an operation to w.

fn fraction_and_time_unit(
    &self,
    timespan: Duration
) -> (Option<f64>, &'static str)

Given a timespan, return a fraction of the timespan based on the given unit, i.e. (possible fraction, unit).