Skip to content

[common] Implement human-readable Display for ByteCount #1171

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Jun 8, 2022
Merged

[common] Implement human-readable Display for ByteCount #1171

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0482880
Implement a user-friendly display for bytecount
smklein Jun 8, 2022
caa0992
fmt
smklein Jun 8, 2022
dff7b32
Update constant names
smklein Jun 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 52 additions & 7 deletions common/src/api/external/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -336,33 +336,54 @@ impl JsonSchema for RoleName {
#[derive(Copy, Clone, Debug, Deserialize, Serialize, JsonSchema, PartialEq)]
pub struct ByteCount(u64);

const KB: u64 = 1024;
const MB: u64 = KB * 1024;
const GB: u64 = MB * 1024;
const TB: u64 = GB * 1024;

impl ByteCount {
pub fn from_kibibytes_u32(kibibytes: u32) -> ByteCount {
ByteCount::try_from(1024 * u64::from(kibibytes)).unwrap()
ByteCount::try_from(KB * u64::from(kibibytes)).unwrap()
}

pub fn from_mebibytes_u32(mebibytes: u32) -> ByteCount {
ByteCount::try_from(1024 * 1024 * u64::from(mebibytes)).unwrap()
ByteCount::try_from(MB * u64::from(mebibytes)).unwrap()
}

pub fn from_gibibytes_u32(gibibytes: u32) -> ByteCount {
ByteCount::try_from(1024 * 1024 * 1024 * u64::from(gibibytes)).unwrap()
ByteCount::try_from(GB * u64::from(gibibytes)).unwrap()
}

pub fn to_bytes(&self) -> u64 {
self.0
}
pub fn to_whole_kibibytes(&self) -> u64 {
self.to_bytes() / 1024
self.to_bytes() / KB
}
pub fn to_whole_mebibytes(&self) -> u64 {
self.to_bytes() / 1024 / 1024
self.to_bytes() / MB
}
pub fn to_whole_gibibytes(&self) -> u64 {
self.to_bytes() / 1024 / 1024 / 1024
self.to_bytes() / GB
}
pub fn to_whole_tebibytes(&self) -> u64 {
self.to_bytes() / 1024 / 1024 / 1024 / 1024
self.to_bytes() / TB
}
}

impl Display for ByteCount {
fn fmt(&self, f: &mut Formatter<'_>) -> FormatResult {
if self.to_bytes() >= TB && self.to_bytes() % TB == 0 {
write!(f, "{} TiB", self.to_whole_tebibytes())
} else if self.to_bytes() >= GB && self.to_bytes() % GB == 0 {
write!(f, "{} GiB", self.to_whole_gibibytes())
} else if self.to_bytes() >= MB && self.to_bytes() % MB == 0 {
write!(f, "{} MiB", self.to_whole_mebibytes())
} else if self.to_bytes() >= KB && self.to_bytes() % KB == 0 {
write!(f, "{} KiB", self.to_whole_kibibytes())
} else {
write!(f, "{} B", self.to_bytes())
}
}
}

Expand Down Expand Up @@ -2083,6 +2104,30 @@ mod test {
assert_eq!(3, tib3.to_whole_tebibytes());
}

#[test]
fn test_bytecount_display() {
assert_eq!(format!("{}", ByteCount::from(0u32)), "0 B".to_string());
assert_eq!(format!("{}", ByteCount::from(1023)), "1023 B".to_string());
assert_eq!(format!("{}", ByteCount::from(1024)), "1 KiB".to_string());
assert_eq!(format!("{}", ByteCount::from(1025)), "1025 B".to_string());
assert_eq!(
format!("{}", ByteCount::from(1024 * 100)),
"100 KiB".to_string()
);
assert_eq!(
format!("{}", ByteCount::from_mebibytes_u32(1)),
"1 MiB".to_string()
);
assert_eq!(
format!("{}", ByteCount::from_gibibytes_u32(1)),
"1 GiB".to_string()
);
assert_eq!(
format!("{}", ByteCount::from_gibibytes_u32(1024)),
"1 TiB".to_string()
);
}

#[test]
fn test_ip_port_range_from_str() {
assert_eq!(
Expand Down