Struct ProgressRatioDisplay 

pub struct ProgressRatioDisplay { /* private fields */ }

Given current and total, displays {current}/{total}.

• If the index_and_total constructor is called, then current is `index
  • 1`.
• If padded is true, current is right-aligned and padded with spaces to the width of total.

Examples

use oxide_update_engine_display::ProgressRatioDisplay;

// 0-based index and total.
let display = ProgressRatioDisplay::index_and_total(0 as u64, 8 as u64);
assert_eq!(display.to_string(), "1/8");

// 1-based current and total.
let display = ProgressRatioDisplay::current_and_total(82 as u64, 230 as u64);
assert_eq!(display.to_string(), "82/230");

// With padding.
let display = display.padded(true);
assert_eq!(display.to_string(), " 82/230");

Implementations

impl ProgressRatioDisplay

pub fn current_and_total<T: ToU64>(current: T, total: T) -> Self

Create a new ProgressRatioDisplay with current and total values.

current is considered to be 1-based. For example, “20/80 jobs done”.

pub fn index_and_total<T: ToU64>(index: T, total: T) -> Self

Create a new ProgressRatioDisplay with index and total values.

The index is 0-based (i.e. 1 is added to it). For example, step index 0 out of 8 total steps is shown as “1/8”.

pub fn padded(self, padded: bool) -> Self

If set to true, the current value is padded to the same width as the total.

Trait Implementations

impl Debug for ProgressRatioDisplay

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

Formats the value using the given formatter.

impl Display for ProgressRatioDisplay

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

Formats the value using the given formatter.