Skip to content

sort -h friendly output mode #15

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

Closed
wants to merge 4 commits into from
Closed

sort -h friendly output mode #15

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f934fa8
fixes article usage
wookietreiber Jan 2, 2019
d3be6c8
adds costomizable byte formatters
wookietreiber Jan 2, 2019
f16ba51
activates ignored crate documentation tests
wookietreiber Jan 2, 2019
123ccb3
updates and simplifies README
wookietreiber Jan 2, 2019
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
4 changes: 2 additions & 2 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[package]
name = "bytesize"
description = "an utility for human-readable bytes representations"
version = "1.0.0"
description = "a utility for human-readable bytes representations"
version = "1.1.0"
authors = ["Hyunsik Choi <[email protected]>"]

homepage = "https://github.com/hyunsik/bytesize/"
Expand Down
82 changes: 17 additions & 65 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
## ByteSize

[![Build Status](https://travis-ci.org/hyunsik/bytesize.svg?branch=master)](https://travis-ci.org/hyunsik/bytesize)
[![Crates.io Version](https://img.shields.io/crates/v/bytesize.svg)](https://crates.io/crates/bytesize)


ByteSize is an utility for human-readable byte count representation.
ByteSize is a utility for human-readable byte count representation.

[API Documentation](https://docs.rs/bytesize/)

Expand All @@ -16,80 +16,32 @@ Add this to your Cargo.toml:
bytesize = "1.0.0"
```

and this to your crate root:
```rust
extern crate bytesize;
```
## Examples

## Example
### Human readable representations (SI unit and Binary unit)

```rust
#[allow(dead_code)]
fn assert_display(expected: &str, b: ByteSize) {
assert_eq!(expected, format!("{}", b));
}

#[test]
fn test_display() {
assert_display("215 B", ByteSize(215));
assert_display("215 B", ByteSize::b(215));
assert_display("1.0 KB", ByteSize::kb(1));
assert_display("301.0 KB", ByteSize::kb(301));
assert_display("419.0 MB", ByteSize::mb(419));
assert_display("518.0 GB", ByteSize::gb(518));
assert_display("815.0 TB", ByteSize::tb(815));
assert_display("609.0 PB", ByteSize::pb(609));
}

fn assert_to_string(expected: &str, b: ByteSize, si: bool) {
assert_eq!(expected.to_string(), b.to_string_as(si));
}

#[test]
fn test_to_string() {
assert_to_string("215 B", ByteSize(215), true);
assert_to_string("215 B", ByteSize(215), false);

assert_to_string("215 B", ByteSize::b(215), true);
assert_to_string("215 B", ByteSize::b(215), false);

assert_to_string("1.0 kiB", ByteSize::kib(1), true);
assert_to_string("1.0 KB", ByteSize::kib(1), false);

assert_to_string("293.9 kiB", ByteSize::kb(301), true);
assert_to_string("301.0 KB", ByteSize::kb(301), false);

assert_to_string("1.0 MiB", ByteSize::mib(1), true);
assert_to_string("1048.6 KB", ByteSize::mib(1), false);

assert_to_string("399.6 MiB", ByteSize::mb(419), true);
assert_to_string("419.0 MB", ByteSize::mb(419), false);

assert_to_string("482.4 GiB", ByteSize::gb(518), true);
assert_to_string("518.0 GB", ByteSize::gb(518), false);

assert_to_string("741.2 TiB", ByteSize::tb(815), true);
assert_to_string("815.0 TB", ByteSize::tb(815), false);

assert_to_string("540.9 PiB", ByteSize::pb(609), true);
assert_to_string("609.0 PB", ByteSize::pb(609), false);
}
extern crate bytesize;

use bytesize::{ByteSize, IEC SI};

assert_eq!("482.4 GiB".to_string(), ByteSize::gb(518).humanize(IEC));
assert_eq!("518.0 GB".to_string(), ByteSize::gb(518).humanize(SI));
```

### Arithmetic operations

```rust
extern crate bytesize;

use bytesize::ByteSize;

fn byte_arithmetic_operator() {
let x = ByteSize::mb(1);
let y = ByteSize::kb(100);
let x = ByteSize::mb(1);
let y = ByteSize::kb(100);

let plus = x + y;
print!("{}", plus);
let sum = x + y;
assert_eq!(sum, ByteSize::kb(1100));

let minus = ByteSize::tb(100) + ByteSize::gb(4);
print!("{}", minus);
}
let product = 10u32 * x;
assert_eq!(product, ByteSize::mb(10));
```
210 changes: 144 additions & 66 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,30 +1,34 @@
//! ByteSize is an utility that easily makes bytes size representation
//! and helps its arithmetic operations.
//! ByteSize is a utility that easily makes bytes size representation and helps
//! its arithmetic operations.
//!
//! ## Example
//! ## Human Readable Representation
//!
//! ```ignore
//! ByteSize provides a human readable string conversion as follows:
//!
//! ```
//! extern crate bytesize;
//!
//! use bytesize::ByteSize;
//! use bytesize::{ByteSize, IEC, SI};
//!
//! fn byte_arithmetic_operator() {
//! let x = ByteSize::mb(1);
//! let y = ByteSize::kb(100);
//! assert_eq!("482.4 GiB".to_string(), ByteSize::gb(518).humanize(IEC));
//! assert_eq!("518.0 GB".to_string(), ByteSize::gb(518).humanize(SI));
//! ```
//!
//! let plus = x + y;
//! print!("{} bytes", plus.as_u64());
//! ## Arithmetic
//!
//! let minus = ByteSize::tb(100) - ByteSize::gb(4);
//! print!("{} bytes", minus.as_u64());
//! }
//! ```
//! extern crate bytesize;
//!
//! use bytesize::ByteSize;
//!
//! let x = ByteSize::mb(1);
//! let y = ByteSize::kb(100);
//!
//! It also provides its human readable string as follows:
//! let sum = x + y;
//! assert_eq!(sum, ByteSize::kb(1100));
//!
//! ```ignore=
//! assert_eq!("482 GiB".to_string(), ByteSize::gb(518).to_string(true));
//! assert_eq!("518 GB".to_string(), ByteSize::gb(518).to_string(false));
//! let product = 10u32 * x;
//! assert_eq!(product, ByteSize::mb(10));
//! ```

#[cfg(feature = "serde")]
Expand Down Expand Up @@ -103,6 +107,65 @@ pub fn pib<V: Into<u64>>(size: V) -> u64 {
size.into() * PIB
}

/// 32 * 1024 Byte = 32 KiB
pub struct IEC;

/// 32 * 1000 Byte = 32 KB
pub struct SI;

/// 32 * 1024 Byte = 32K
pub struct Sort;

fn humanize(bytes: u64, si: bool, prefix: &str, suffix: &str) -> String {
let unit = if si { KB } else { KIB };
let unit_base = if si { LN_KB } else { LN_KIB };
let unit_prefix = if si {
UNITS_SI.as_bytes()
} else {
UNITS.as_bytes()
};

if bytes < unit {
format!("{}{}B", bytes, prefix)
} else {
let size = bytes as f64;
let exp = match (size.ln() / unit_base) as usize {
e if e == 0 => 1,
e => e,
};

format!(
"{:.1}{}{}{}",
(size / unit.pow(exp as u32) as f64),
prefix,
unit_prefix[exp - 1] as char,
suffix
)
}
}

pub trait ByteFormatter {
fn humanize(&self, bytes: u64) -> String;
}

impl ByteFormatter for IEC {
fn humanize(&self, bytes: u64) -> String {
humanize(bytes, false, " ", "iB")
}
}

impl ByteFormatter for SI {
fn humanize(&self, bytes: u64) -> String {
humanize(bytes, true, " ", "B")
}
}

impl ByteFormatter for Sort {
fn humanize(&self, bytes: u64) -> String {
humanize(bytes, false, "", "")
}
}

/// Byte size representation
#[derive(Copy, Clone, PartialEq, PartialOrd, Eq, Ord, Default)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
Expand Down Expand Up @@ -169,43 +232,47 @@ impl ByteSize {
self.0
}

#[deprecated(since = "1.1.0", note = "use `bs.humanize(SI|IEC)`")]
#[inline(always)]
pub fn to_string_as(&self, si_unit: bool) -> String {
to_string(self.0, si_unit)
if si_unit {
self.humanize(SI)
} else {
self.humanize(IEC)
}
}

/// Returns humanized String representation.
///
/// ## Examples
///
/// ```
/// # extern crate bytesize;
/// # use bytesize::*;
/// assert_eq!("1.0 KiB", ByteSize::b(1024).humanize(IEC));
/// assert_eq!("1.0 kB", ByteSize::b(1000).humanize(SI));
/// ```
#[inline(always)]
pub fn humanize<F>(&self, fmt: F) -> String
where
F: ByteFormatter,
{
fmt.humanize(self.0)
}
}

#[deprecated(since = "1.1.0", note = "use `ByteSize::b(bytes).humanize(SI|IEC)`")]
pub fn to_string(bytes: u64, si_prefix: bool) -> String {
let unit = if si_prefix { KIB } else { KB };
let unit_base = if si_prefix { LN_KIB } else { LN_KB };
let unit_prefix = if si_prefix {
UNITS_SI.as_bytes()
if si_prefix {
humanize(bytes, si_prefix, " ", "B")
} else {
UNITS.as_bytes()
};
let unit_suffix = if si_prefix { "iB" } else { "B" };

if bytes < unit {
format!("{} B", bytes)
} else {
let size = bytes as f64;
let exp = match (size.ln() / unit_base) as usize {
e if e == 0 => 1,
e => e,
};

format!(
"{:.1} {}{}",
(size / unit.pow(exp as u32) as f64),
unit_prefix[exp - 1] as char,
unit_suffix
)
humanize(bytes, si_prefix, " ", "iB")
}
}

impl Display for ByteSize {
fn fmt(&self, f: &mut Formatter) -> Result {
write!(f, "{}", to_string(self.0, false))
write!(f, "{}", self.humanize(SI))
}
}

Expand Down Expand Up @@ -310,47 +377,58 @@ mod tests {
#[test]
fn test_display() {
assert_display("215 B", ByteSize::b(215));
assert_display("1.0 KB", ByteSize::kb(1));
assert_display("301.0 KB", ByteSize::kb(301));
assert_display("1.0 kB", ByteSize::kb(1));
assert_display("301.0 kB", ByteSize::kb(301));
assert_display("419.0 MB", ByteSize::mb(419));
assert_display("518.0 GB", ByteSize::gb(518));
assert_display("815.0 TB", ByteSize::tb(815));
assert_display("609.0 PB", ByteSize::pb(609));
}

fn assert_to_string(expected: &str, b: ByteSize, si: bool) {
assert_eq!(expected.to_string(), b.to_string_as(si));
fn assert_humanize<F>(expected: &str, b: ByteSize, fmt: F)
where
F: ByteFormatter,
{
assert_eq!(expected.to_string(), b.humanize(fmt));
}

#[test]
fn test_to_string_as() {
assert_to_string("215 B", ByteSize::b(215), true);
assert_to_string("215 B", ByteSize::b(215), false);
fn test_humanize() {
assert_humanize("215 B", ByteSize::b(215), IEC);
assert_humanize("215 B", ByteSize::b(215), SI);

assert_to_string("1.0 kiB", ByteSize::kib(1), true);
assert_to_string("1.0 KB", ByteSize::kib(1), false);
assert_humanize("1.0 KiB", ByteSize::kib(1), IEC);
assert_humanize("1.0 kB", ByteSize::kib(1), SI);
assert_humanize("1.0K", ByteSize::kib(1), Sort);

assert_to_string("293.9 kiB", ByteSize::kb(301), true);
assert_to_string("301.0 KB", ByteSize::kb(301), false);
assert_humanize("293.9 KiB", ByteSize::kb(301), IEC);
assert_humanize("301.0 kB", ByteSize::kb(301), SI);
assert_humanize("293.9K", ByteSize::kb(301), Sort);

assert_to_string("1.0 MiB", ByteSize::mib(1), true);
assert_to_string("1048.6 KB", ByteSize::mib(1), false);
assert_humanize("1.0 MiB", ByteSize::mib(1), IEC);
assert_humanize("1048.6 kB", ByteSize::mib(1), SI);
assert_humanize("1.0M", ByteSize::mib(1), Sort);

// a bug case: https://github.com/flang-project/bytesize/issues/8
assert_to_string("1.9 GiB", ByteSize::mib(1907), true);
assert_to_string("2.0 GB", ByteSize::mib(1908), false);
assert_humanize("1.9 GiB", ByteSize::mib(1907), IEC);
assert_humanize("2.0 GB", ByteSize::mib(1908), SI);
assert_humanize("1.9G", ByteSize::mib(1907), Sort);

assert_to_string("399.6 MiB", ByteSize::mb(419), true);
assert_to_string("419.0 MB", ByteSize::mb(419), false);
assert_humanize("399.6 MiB", ByteSize::mb(419), IEC);
assert_humanize("419.0 MB", ByteSize::mb(419), SI);
assert_humanize("399.6M", ByteSize::mb(419), Sort);

assert_to_string("482.4 GiB", ByteSize::gb(518), true);
assert_to_string("518.0 GB", ByteSize::gb(518), false);
assert_humanize("482.4 GiB", ByteSize::gb(518), IEC);
assert_humanize("518.0 GB", ByteSize::gb(518), SI);
assert_humanize("482.4G", ByteSize::gb(518), Sort);

assert_to_string("741.2 TiB", ByteSize::tb(815), true);
assert_to_string("815.0 TB", ByteSize::tb(815), false);
assert_humanize("741.2 TiB", ByteSize::tb(815), IEC);
assert_humanize("815.0 TB", ByteSize::tb(815), SI);
assert_humanize("741.2T", ByteSize::tb(815), Sort);

assert_to_string("540.9 PiB", ByteSize::pb(609), true);
assert_to_string("609.0 PB", ByteSize::pb(609), false);
assert_humanize("540.9 PiB", ByteSize::pb(609), IEC);
assert_humanize("609.0 PB", ByteSize::pb(609), SI);
assert_humanize("540.9P", ByteSize::pb(609), Sort);
}

#[test]
Expand All @@ -360,6 +438,6 @@ mod tests {

#[test]
fn test_to_string() {
assert_to_string("609.0 PB", ByteSize::pb(609), false);
assert_humanize("609.0 PB", ByteSize::pb(609), SI);
}
}