https://github.com/depp/bytesize-rs
Format data sizes for humans
https://github.com/depp/bytesize-rs
Last synced: 8 months ago
JSON representation
Format data sizes for humans
- Host: GitHub
- URL: https://github.com/depp/bytesize-rs
- Owner: depp
- License: apache-2.0
- Created: 2022-07-21T22:41:41.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-07-22T04:37:27.000Z (almost 4 years ago)
- Last Synced: 2025-03-22T12:18:54.449Z (about 1 year ago)
- Language: Rust
- Size: 12.7 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE.txt
Awesome Lists containing this project
README
# ByteSize (Rust)
**Simple** and **correct.**
ByteSize is a Rust library for formatting and parsing numbers as byte sizes for humans. Numbers are formatted with three digits of precision, using SI prefixes, and the unit “B” for bytes. For example, 1000 is formatted as “1.00 KB”. The numbers are rounded using round-to-even, which is the familiar method used by `std::fmt`.
There are no choices to make. ByteSize is not configurable.
This library is also available for Go: https://github.com/depp/bytesize
## Formatting
The precision cannot be changed. Non-decimal prefixes are not produced: no kibibytes, no powers of two. Wrap the number in the `ByteSize` struct and print it with `std::fmt`.
```rust
/// A byte size which is displayed using SI prefixes.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct ByteSize(pub u64);
```
All corner cases should be handled correctly and you should never see unusual or unexpected output. You should always see exactly three digits, except for inputs under 100.
Some test cases:
```
0 => "0 B"
999 => "999 B"
1000 => "1.00 kB"
1005 => "1.00 kB"
1006 => "1.01 kB"
1014 => "1.01 kB"
1015 => "1.02 kB"
9995 => "10.0 kB"
314000 => "314 kB"
18400000000000000000 => "18.4 EB"
```
## Parsing
The parser understands decimal numbers, decimal SI prefixes, and binary SI prefixes. It is not case-sensitive. A sequence ASCII space (0x20) and tab (0x09) characters may optionally appear between the number and the units. The parser will recognize all positve prefixes which are powers of 1,000, including prefixes that will overflow (yotta and zetta).
Some test cases:
```
"0" => 0
"1" => 1
"555k" => 555000
"15 EiB" => 17293822569102704640
"1.5 mb" => 1500000
"2gi" => 2147483648
"0.001 zb" => 1000000000000000000
```
## License
This library is licensed under the terms of both the MIT license and the Apache 2.0 license. See [LICENSE-MIT.txt](LICENSE-MIT.txt) and [LICENSE-APACHE.txt](LICENSE-APACHE.txt) for details.