//! Scalar presentation vocabulary shared by the CLI frontends. //! //! Stream output, the run summary, and the TUI display different metrics in //! different layouts, but they render the same *scalars*: nanosecond-scale //! durations, percentages, and counts. This module owns those spellings so the //! frontends cannot drift apart on units, rounding, or how an absent value is //! rendered. //! //! It is presentation only. Nothing here belongs in `irtt-stats`, and it is //! deliberately not a general formatting framework: it holds exactly the //! vocabulary more than one frontend needs. use std::time::Duration; #[cfg(feature = "client")] use irtt_client::SignedDuration; /// Rendering used wherever a scalar is unavailable. pub(crate) const ABSENT: &str = "-"; /// Format a nanosecond scalar. /// /// Unit selection and rounding are one policy for every frontend: /// /// | magnitude | unit | precision | /// |-----------|------|-----------| /// | `< 1µs` | `ns` | whole | /// | `< 1ms` | `µs` | 1 decimal | /// | `< 1s` | `ms` | 1 decimal | /// | `>= 1s` | `s` | 3 decimals | /// /// Negative values are meaningful (clock offsets, one-way deltas, IPDV), so /// the unit is selected from the magnitude and the sign is preserved. Values /// that are not finite render as [`ABSENT`]. pub(crate) fn format_ns_f64(value: f64) -> String { if !value.is_finite() { return ABSENT.to_owned(); } let sign = if value.is_sign_negative() { "-" } else { "" }; let magnitude = value.abs(); if magnitude < 1_000.0 { format!("{sign}{magnitude:.0}ns") } else if magnitude < 1_000_000.0 { format!("{sign}{:.1}µs", magnitude / 1_000.0) } else if magnitude < 1_000_000_000.0 { format!("{sign}{:.1}ms", magnitude / 1_000_000.0) } else { format!("{sign}{:.3}s", magnitude / 1_000_000_000.0) } } /// Format an exact nanosecond scalar with [`format_ns_f64`]'s policy. pub(crate) fn format_ns_i128(value: i128) -> String { let sign = if value < 0 { "-" } else { "" }; let magnitude = value.saturating_abs() as f64; format!("{sign}{}", format_ns_f64(magnitude)) } /// Format an optional nanosecond scalar, rendering `None` as [`ABSENT`]. pub(crate) fn format_optional_ns_i128(value: Option) -> String { value.map(format_ns_i128).unwrap_or_else(absent) } /// Format an optional nanosecond scalar, rendering `None` as [`ABSENT`]. #[cfg(feature = "client")] pub(crate) fn format_optional_ns_f64(value: Option) -> String { value.map(format_ns_f64).unwrap_or_else(absent) } /// Format a duration as a nanosecond scalar. pub(crate) fn format_duration(value: Duration) -> String { format_ns_i128(i128::try_from(value.as_nanos()).unwrap_or(i128::MAX)) } /// Format a signed duration as a nanosecond scalar, preserving its sign. #[cfg(feature = "client")] pub(crate) fn format_signed_duration(value: SignedDuration) -> String { format_ns_i128(value.as_nanos()) } /// Format a percentage with two decimals; non-finite values render as /// [`ABSENT`]. pub(crate) fn format_percent(value: f64) -> String { if value.is_finite() { format!("{value:.2}%") } else { ABSENT.to_owned() } } /// Format `value` as a percentage of `total`, capped at 100%. /// /// A zero total has no percentage to report and renders as [`ABSENT`]. #[cfg(feature = "tui")] pub(crate) fn format_percent_ratio(value: u64, total: u64) -> String { if total == 0 { ABSENT.to_owned() } else { format_percent((value as f64 / total as f64 * 100.0).min(100.0)) } } /// Format a scalar count. #[cfg(feature = "tui")] pub(crate) fn format_count(value: u64) -> String { value.to_string() } /// Format an optional scalar count, rendering `None` as [`ABSENT`]. #[cfg(feature = "tui")] pub(crate) fn format_optional_count(value: Option) -> String { value.map(format_count).unwrap_or_else(absent) } fn absent() -> String { ABSENT.to_owned() }