Struct Unit

pub struct Unit { /* private fields */ }

Available on crate feature progress only.

A configurable and flexible unit for use in Progress::init().

Implementations

impl Unit

Display and utilities

pub fn display( &self, current_value: usize, upper_bound: Option<usize>, throughput: impl Into<Option<Throughput>>, ) -> UnitDisplay<'_>

Create a representation of self implementing Display in configurable fashion.

• current_value is the progress value to display.
• upper_bound is the possibly available upper bound of current_value.
• throughput configures how throughput should be displayed if already available.

Note that throughput is usually not available the first time a value is displayed.

pub fn as_display_value(&self) -> &dyn DisplayValue

Return self as trait object implementing DisplayValue.

Trait Implementations

impl Clone for Unit

fn clone(&self) -> Unit

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Unit

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

Formats the value using the given formatter.

impl From<&'static str> for Unit

fn from(v: &'static str) -> Unit

Converts to this type from the input type.

impl Hash for Unit

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.