prodash 23.1.2

A dashboard for visualizing progress of asynchronous and possibly blocking tasks
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47

use std::{fmt, fmt::Debug, hash::Hasher};

pub use human_format::{Formatter, Scales};

use crate::{progress::Step, unit::DisplayValue};

/// A helper for formatting numbers in a format easily read by humans in renderers, as in `2.54 million objects`
#[derive(Debug)]
pub struct Human {
    /// The name of the represented unit, like 'items' or 'objects'.
    pub name: &'static str,
    /// The formatter to format the actual numbers.
    pub formatter: Formatter,
}

impl Human {
    /// A convenience method to create a new new instance and its `formatter` and `name` fields.
    pub fn new(formatter: Formatter, name: &'static str) -> Self {
        Human { name, formatter }
    }
    fn format_bytes(&self, w: &mut dyn fmt::Write, value: Step) -> fmt::Result {
        let string = self.formatter.format(value as f64);
        for token in string.split(' ') {
            w.write_str(token)?;
        }
        Ok(())
    }
}

impl DisplayValue for Human {
    fn display_current_value(&self, w: &mut dyn fmt::Write, value: Step, _upper: Option<Step>) -> fmt::Result {
        self.format_bytes(w, value)
    }

    fn display_upper_bound(&self, w: &mut dyn fmt::Write, upper_bound: Step, _value: Step) -> fmt::Result {
        self.format_bytes(w, upper_bound)
    }

    fn dyn_hash(&self, state: &mut dyn Hasher) {
        state.write(self.name.as_bytes());
        state.write_u8(0);
    }

    fn display_unit(&self, w: &mut dyn fmt::Write, _value: Step) -> fmt::Result {
        w.write_str(self.name)
    }
}