Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

HumanFloatCount for per_sec #453

Merged
merged 7 commits into from Aug 2, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
55 changes: 55 additions & 0 deletions src/format.rs
Expand Up @@ -34,6 +34,10 @@ pub struct BinaryBytes(pub u64);
#[derive(Debug)]
pub struct HumanCount(pub u64);

/// Formats counts for human readability using commas for floats
#[derive(Debug)]
pub struct HumanFloatCount(pub f64);

impl fmt::Display for FormattedDuration {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let mut t = self.0.as_secs();
Expand Down Expand Up @@ -146,6 +150,32 @@ impl fmt::Display for HumanCount {
}
}

impl fmt::Display for HumanFloatCount {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
use fmt::Write;

let num = format!("{:.4}", self.0);
let (int_part, frac_part) = match num.split_once('.') {
Some((int_str, fract_str)) => (int_str.to_string(), fract_str),
None => (self.0.trunc().to_string(), ""),
};
let len = int_part.len();
for (idx, c) in int_part.chars().enumerate() {
let pos = len - idx - 1;
f.write_char(c)?;
if pos > 0 && pos % 3 == 0 {
f.write_char(',')?;
}
}
let frac_trimmed = frac_part.trim_end_matches('0');
if !frac_trimmed.is_empty() {
f.write_char('.')?;
f.write_str(frac_trimmed)?;
}
Ok(())
}
}

#[cfg(test)]
mod tests {
use super::*;
Expand Down Expand Up @@ -282,4 +312,29 @@ mod tests {
assert_eq!("12,345", format!("{}", HumanCount(12345)));
assert_eq!("1,234,567,890", format!("{}", HumanCount(1234567890)));
}

#[test]
fn human_float_count() {
assert_eq!("42", format!("{}", HumanFloatCount(42.0)));
assert_eq!("7,654", format!("{}", HumanFloatCount(7654.0)));
assert_eq!("12,345", format!("{}", HumanFloatCount(12345.0)));
assert_eq!(
"1,234,567,890",
format!("{}", HumanFloatCount(1234567890.0))
);
assert_eq!("42.5", format!("{}", HumanFloatCount(42.5)));
assert_eq!("42.5", format!("{}", HumanFloatCount(42.500012345)));
assert_eq!("42.502", format!("{}", HumanFloatCount(42.502012345)));
assert_eq!("7,654.321", format!("{}", HumanFloatCount(7654.321)));
assert_eq!("7,654.321", format!("{}", HumanFloatCount(7654.3210123456)));
assert_eq!("12,345.6789", format!("{}", HumanFloatCount(12345.6789)));
assert_eq!(
"1,234,567,890.1235",
format!("{}", HumanFloatCount(1234567890.1234567))
);
assert_eq!(
"1,234,567,890.1234",
format!("{}", HumanFloatCount(1234567890.1234321))
);
}
}
5 changes: 4 additions & 1 deletion src/lib.rs
Expand Up @@ -24,6 +24,7 @@
//! * [`BinaryBytes`](struct.BinaryBytes.html) for formatting bytes using ISO/IEC prefixes
//! * [`HumanDuration`](struct.HumanDuration.html) for formatting durations
//! * [`HumanCount`](struct.HumanCount.html) for formatting large counts
//! * [`HumanFloatCount`](struct.HumanFloatCount.html) for formatting large float counts
//!
//! # Progress Bars and Spinners
//!
Expand Down Expand Up @@ -200,11 +201,12 @@
//!
//! ```rust
//! # use std::time::Duration;
//! use indicatif::{HumanBytes, HumanCount, HumanDuration};
//! use indicatif::{HumanBytes, HumanCount, HumanDuration, HumanFloatCount};
//!
//! assert_eq!("3.00 MiB", HumanBytes(3*1024*1024).to_string());
//! assert_eq!("8 seconds", HumanDuration(Duration::from_secs(8)).to_string());
//! assert_eq!("33,857,009", HumanCount(33857009).to_string());
//! assert_eq!("33,857,009.1235", HumanFloatCount(33857009.123456).to_string());
//! ```
//!
//! # Feature Flags
Expand All @@ -231,6 +233,7 @@ mod term_like;
pub use crate::draw_target::ProgressDrawTarget;
pub use crate::format::{
BinaryBytes, DecimalBytes, FormattedDuration, HumanBytes, HumanCount, HumanDuration,
HumanFloatCount,
};
#[cfg(feature = "in_memory")]
pub use crate::in_memory::InMemoryTerm;
Expand Down
3 changes: 2 additions & 1 deletion src/style.rs
Expand Up @@ -9,6 +9,7 @@ use unicode_segmentation::UnicodeSegmentation;

use crate::format::{
BinaryBytes, DecimalBytes, FormattedDuration, HumanBytes, HumanCount, HumanDuration,
HumanFloatCount,
};
use crate::state::{ProgressState, TabExpandedString, DEFAULT_TAB_WIDTH};

Expand Down Expand Up @@ -300,7 +301,7 @@ impl ProgressStyle {
.write_fmt(format_args!("{:#}", HumanDuration(state.elapsed())))
.unwrap(),
"per_sec" => buf
.write_fmt(format_args!("{:.4}/s", state.per_sec()))
.write_fmt(format_args!("{}/s", HumanFloatCount(state.per_sec())))
.unwrap(),
"bytes_per_sec" => buf
.write_fmt(format_args!("{}/s", HumanBytes(state.per_sec() as u64)))
Expand Down