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 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70
//! ## A Rust crate that convert bytes into human-readable values.
//!
//! It can return either KB/MB/GB/TB or KiB/MiB/GiB/TiB via the `bibytes` feature,
//! which enables the [IEC prefix](https://en.wikipedia.org/wiki/Byte#Units_based_on_powers_of_2).
//!
//! > `(1 KB = 1024 B, 1 KiB = 1024 B, the only thing that changes is the suffix)`
//!
//! It supports from 0 bytes to several yottabytes (I cannot tell how many because I have to use `u128`s
//! to fit a single YB)
//!
//! For more info, check the [README.md](https://gitlab.com/forkbomb9/human_bytes-rs)
//!
//! # Example
//!
//! ```no_run
//! use human_bytes::human_bytes;
//!
//! assert_eq!(human_bytes(563_200_u32), "550 KB".to_string());
//! // or
//! assert_eq!(human_bytes(563_200_u64 as f64), "550 KB".to_string());
//! // ________________________________/
//! // |
//! // | Needed only when you're using `u64` values,
//! // | because `f64` doesn't implement `std::convert::From<u64>`
//!
//! // With the `bibytes` feature enabled:
//! assert_eq!(human_bytes(563_200_u32), "550 KiB".to_string());
//! ```
#[cfg(test)]
mod tests;
#[cfg(not(feature = "bibytes"))]
// Just be future-proof
const SUFFIX: [&'static str; 9] = ["B", "KB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB"];
#[cfg(feature = "bibytes")]
// Just be future-proof
const SUFFIX: [&'static str; 9] = ["B", "KiB", "MiB", "GiB", "TiB", "PiB", "EiB", "ZiB", "YiB"];
/// Converts bytes to human-readable values
pub fn human_bytes<T: Into<f64>>(size: T) -> String {
let size = size.into();
if size <= 0.0 {
return "0 B".to_string();
}
let base = size.log10() / 1024_f64.log10();
#[cfg(feature = "fast")]
// Source for this hack: https://stackoverflow.com/a/28656825
let mut result = lexical::to_string((1024_f64.powf(base - base.floor()) * 10.0).round() / 10.0)
.trim_end_matches(".0")
.to_owned();
// This is faster, but leaves you with things like "2.500000000000002 TB" or 15.299999999813716 GB.
// let result = lexical::to_string(1024_f64.powf(base - base.floor()));
#[cfg(not(feature = "fast"))]
let mut result = format!("{:.1}", 1024_f64.powf(base - base.floor()),)
.trim_end_matches(".0")
.to_owned();
// Add suffix
result.push(' ');
result.push_str(SUFFIX[base.floor() as usize]);
result
}