/rust/registry/src/index.crates.io-1949cf8c6b5b557f/prodash-31.0.0/src/unit/traits.rs

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

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

/// A trait to encapsulate all capabilities needed to display a value with unit within a renderer.
pub trait DisplayValue {
    /// Display the absolute `value` representing the current progress of an operation and write it to `w`.
    ///
    /// The `upper` bound is possibly provided when known to add context, even though it is not to be output
    /// as part of this method call.
    fn display_current_value(&self, w: &mut dyn fmt::Write, value: Step, _upper: Option<Step>) -> fmt::Result {
        fmt::write(w, format_args!("{}", value))
    }
    /// Emit a token to separate two values.
    ///
    /// The `value` and its `upper` bound are provided to add context, even though it is not to be output
    /// as part of this method call.
    fn separator(&self, w: &mut dyn fmt::Write, _value: Step, _upper: Option<Step>) -> fmt::Result {
        w.write_str("/")
    }

    /// Emit the `upper_bound` to `w`.
    ///
    /// The `value` is provided to add context, even though it is not to be output as part of this method call.
    fn display_upper_bound(&self, w: &mut dyn fmt::Write, upper_bound: Step, _value: Step) -> fmt::Result {
        fmt::write(w, format_args!("{}", upper_bound))
    }

    /// A way to hash our state without using generics.
    ///
    /// This helps to determine quickly if something changed.
    fn dyn_hash(&self, state: &mut dyn std::hash::Hasher);

    /// Emit the unit of `value` to `w`.
    ///
    /// The `value` is provided to add context, even though it is not to be output as part of this method call.
    fn display_unit(&self, w: &mut dyn fmt::Write, value: Step) -> fmt::Result;

    /// Emit `percentage` to `w`.
    fn display_percentage(&self, w: &mut dyn fmt::Write, percentage: f64) -> fmt::Result {
        w.write_fmt(format_args!("[{}%]", percentage as usize))
    }

    /// Emit the `throughput` of an operation to `w`.
    fn display_throughput(&self, w: &mut dyn fmt::Write, throughput: &display::Throughput) -> fmt::Result {
        let (fraction, unit) = self.fraction_and_time_unit(throughput.timespan);
        w.write_char('|')?;
        self.display_current_value(w, throughput.value_change_in_timespan, None)?;
        w.write_char('/')?;
        match fraction {
            Some(fraction) => w.write_fmt(format_args!("{}", fraction)),
            None => Ok(()),
        }?;
        w.write_fmt(format_args!("{}|", unit))
    }

    /// Given a `timespan`, return a fraction of the timespan based on the given unit, i.e. `(possible fraction, unit`).
    fn fraction_and_time_unit(&self, timespan: std::time::Duration) -> (Option<f64>, &'static str) {
        fn skip_one(v: f64) -> Option<f64> {
            if (v - 1.0).abs() < f64::EPSILON {
                None
            } else {
                Some(v)
            }
        }
        const HOUR_IN_SECS: u64 = 60 * 60;
        let secs = timespan.as_secs();
        let h = secs / HOUR_IN_SECS;
        if h > 0 {
            return (skip_one(secs as f64 / HOUR_IN_SECS as f64), "h");
        }
        const MINUTES_IN_SECS: u64 = 60;
        let m = secs / MINUTES_IN_SECS;
        if m > 0 {
            return (skip_one(secs as f64 / MINUTES_IN_SECS as f64), "m");
        }
        if secs > 0 {
            return (skip_one(secs as f64), "s");
        }

        (skip_one(timespan.as_millis() as f64), "ms")
    }
}

impl DisplayValue for &'static str {
    fn dyn_hash(&self, state: &mut dyn Hasher) {
        state.write(self.as_bytes())
    }

    fn display_unit(&self, w: &mut dyn fmt::Write, _value: usize) -> fmt::Result {
        w.write_fmt(format_args!("{}", self))
    }
}

Line	Count	Source
1		use std::{fmt, hash::Hasher};
2
3		use crate::{progress::Step, unit::display};
4
5		/// A trait to encapsulate all capabilities needed to display a value with unit within a renderer.
6		pub trait DisplayValue {
7		/// Display the absolute `value` representing the current progress of an operation and write it to `w`.
8		///
9		/// The `upper` bound is possibly provided when known to add context, even though it is not to be output
10		/// as part of this method call.
11	0	fn display_current_value(&self, w: &mut dyn fmt::Write, value: Step, _upper: Option<Step>) -> fmt::Result {
12	0	fmt::write(w, format_args!("{}", value))
13	0	} Unexecuted instantiation: <&str as prodash::unit::traits::DisplayValue>::display_current_value Unexecuted instantiation: <&str as prodash::unit::traits::DisplayValue>::display_current_value Unexecuted instantiation: <&str as prodash::unit::traits::DisplayValue>::display_current_value Unexecuted instantiation: <&str as prodash::unit::traits::DisplayValue>::display_current_value Unexecuted instantiation: <&str as prodash::unit::traits::DisplayValue>::display_current_value Unexecuted instantiation: <&str as prodash::unit::traits::DisplayValue>::display_current_value
14		/// Emit a token to separate two values.
15		///
16		/// The `value` and its `upper` bound are provided to add context, even though it is not to be output
17		/// as part of this method call.
18	0	fn separator(&self, w: &mut dyn fmt::Write, _value: Step, _upper: Option<Step>) -> fmt::Result {
19	0	w.write_str("/")
20	0	} Unexecuted instantiation: <&str as prodash::unit::traits::DisplayValue>::separator Unexecuted instantiation: <&str as prodash::unit::traits::DisplayValue>::separator Unexecuted instantiation: <&str as prodash::unit::traits::DisplayValue>::separator Unexecuted instantiation: <&str as prodash::unit::traits::DisplayValue>::separator Unexecuted instantiation: <&str as prodash::unit::traits::DisplayValue>::separator Unexecuted instantiation: <&str as prodash::unit::traits::DisplayValue>::separator
21
22		/// Emit the `upper_bound` to `w`.
23		///
24		/// The `value` is provided to add context, even though it is not to be output as part of this method call.
25	0	fn display_upper_bound(&self, w: &mut dyn fmt::Write, upper_bound: Step, _value: Step) -> fmt::Result {
26	0	fmt::write(w, format_args!("{}", upper_bound))
27	0	} Unexecuted instantiation: <prodash::unit::range::Range as prodash::unit::traits::DisplayValue>::display_upper_bound Unexecuted instantiation: <&str as prodash::unit::traits::DisplayValue>::display_upper_bound Unexecuted instantiation: <&str as prodash::unit::traits::DisplayValue>::display_upper_bound Unexecuted instantiation: <prodash::unit::range::Range as prodash::unit::traits::DisplayValue>::display_upper_bound Unexecuted instantiation: <&str as prodash::unit::traits::DisplayValue>::display_upper_bound Unexecuted instantiation: <prodash::unit::range::Range as prodash::unit::traits::DisplayValue>::display_upper_bound Unexecuted instantiation: <&str as prodash::unit::traits::DisplayValue>::display_upper_bound Unexecuted instantiation: <&str as prodash::unit::traits::DisplayValue>::display_upper_bound Unexecuted instantiation: <&str as prodash::unit::traits::DisplayValue>::display_upper_bound
28
29		/// A way to hash our state without using generics.
30		///
31		/// This helps to determine quickly if something changed.
32		fn dyn_hash(&self, state: &mut dyn std::hash::Hasher);
33
34		/// Emit the unit of `value` to `w`.
35		///
36		/// The `value` is provided to add context, even though it is not to be output as part of this method call.
37		fn display_unit(&self, w: &mut dyn fmt::Write, value: Step) -> fmt::Result;
38
39		/// Emit `percentage` to `w`.
40	0	fn display_percentage(&self, w: &mut dyn fmt::Write, percentage: f64) -> fmt::Result {
41	0	w.write_fmt(format_args!("[{}%]", percentage as usize))
42	0	} Unexecuted instantiation: <prodash::unit::range::Range as prodash::unit::traits::DisplayValue>::display_percentage Unexecuted instantiation: <&str as prodash::unit::traits::DisplayValue>::display_percentage Unexecuted instantiation: <&str as prodash::unit::traits::DisplayValue>::display_percentage Unexecuted instantiation: <prodash::unit::range::Range as prodash::unit::traits::DisplayValue>::display_percentage Unexecuted instantiation: <&str as prodash::unit::traits::DisplayValue>::display_percentage Unexecuted instantiation: <prodash::unit::range::Range as prodash::unit::traits::DisplayValue>::display_percentage Unexecuted instantiation: <&str as prodash::unit::traits::DisplayValue>::display_percentage Unexecuted instantiation: <&str as prodash::unit::traits::DisplayValue>::display_percentage Unexecuted instantiation: <&str as prodash::unit::traits::DisplayValue>::display_percentage
43
44		/// Emit the `throughput` of an operation to `w`.
45	0	fn display_throughput(&self, w: &mut dyn fmt::Write, throughput: &display::Throughput) -> fmt::Result {
46	0	let (fraction, unit) = self.fraction_and_time_unit(throughput.timespan);
47	0	w.write_char('\|')?;
48	0	self.display_current_value(w, throughput.value_change_in_timespan, None)?;
49	0	w.write_char('/')?;
50	0	match fraction {
51	0	Some(fraction) => w.write_fmt(format_args!("{}", fraction)),
52	0	None => Ok(()),
53	0	}?;
54	0	w.write_fmt(format_args!("{}\|", unit))
55	0	} Unexecuted instantiation: <prodash::unit::range::Range as prodash::unit::traits::DisplayValue>::display_throughput Unexecuted instantiation: <&str as prodash::unit::traits::DisplayValue>::display_throughput Unexecuted instantiation: <&str as prodash::unit::traits::DisplayValue>::display_throughput Unexecuted instantiation: <prodash::unit::range::Range as prodash::unit::traits::DisplayValue>::display_throughput Unexecuted instantiation: <&str as prodash::unit::traits::DisplayValue>::display_throughput Unexecuted instantiation: <prodash::unit::range::Range as prodash::unit::traits::DisplayValue>::display_throughput Unexecuted instantiation: <&str as prodash::unit::traits::DisplayValue>::display_throughput Unexecuted instantiation: <&str as prodash::unit::traits::DisplayValue>::display_throughput Unexecuted instantiation: <&str as prodash::unit::traits::DisplayValue>::display_throughput
56
57		/// Given a `timespan`, return a fraction of the timespan based on the given unit, i.e. `(possible fraction, unit`).
58	0	fn fraction_and_time_unit(&self, timespan: std::time::Duration) -> (Option<f64>, &'static str) {
59	0	fn skip_one(v: f64) -> Option<f64> {
60	0	if (v - 1.0).abs() < f64::EPSILON {
61	0	None
62		} else {
63	0	Some(v)
64		}
65	0	}
66		const HOUR_IN_SECS: u64 = 60 * 60;
67	0	let secs = timespan.as_secs();
68	0	let h = secs / HOUR_IN_SECS;
69	0	if h > 0 {
70	0	return (skip_one(secs as f64 / HOUR_IN_SECS as f64), "h");
71	0	}
72		const MINUTES_IN_SECS: u64 = 60;
73	0	let m = secs / MINUTES_IN_SECS;
74	0	if m > 0 {
75	0	return (skip_one(secs as f64 / MINUTES_IN_SECS as f64), "m");
76	0	}
77	0	if secs > 0 {
78	0	return (skip_one(secs as f64), "s");
79	0	}
80
81	0	(skip_one(timespan.as_millis() as f64), "ms")
82	0	} Unexecuted instantiation: <prodash::unit::range::Range as prodash::unit::traits::DisplayValue>::fraction_and_time_unit Unexecuted instantiation: <&str as prodash::unit::traits::DisplayValue>::fraction_and_time_unit Unexecuted instantiation: <&str as prodash::unit::traits::DisplayValue>::fraction_and_time_unit Unexecuted instantiation: <prodash::unit::range::Range as prodash::unit::traits::DisplayValue>::fraction_and_time_unit Unexecuted instantiation: <&str as prodash::unit::traits::DisplayValue>::fraction_and_time_unit Unexecuted instantiation: <prodash::unit::range::Range as prodash::unit::traits::DisplayValue>::fraction_and_time_unit Unexecuted instantiation: <&str as prodash::unit::traits::DisplayValue>::fraction_and_time_unit Unexecuted instantiation: <&str as prodash::unit::traits::DisplayValue>::fraction_and_time_unit Unexecuted instantiation: <&str as prodash::unit::traits::DisplayValue>::fraction_and_time_unit
83		}
84
85		impl DisplayValue for &'static str {
86	0	fn dyn_hash(&self, state: &mut dyn Hasher) {
87	0	state.write(self.as_bytes())
88	0	}
89
90	0	fn display_unit(&self, w: &mut dyn fmt::Write, _value: usize) -> fmt::Result {
91	0	w.write_fmt(format_args!("{}", self))
92	0	}
93		}

Coverage Report

Created: 2026-06-30 06:48