Sapphirus/SimpleByteUnit
1
0
Fork 0
Code Issues Releases 1 Activity Actions

Cleaned up documentation, refactored FromStr impl, and added Debug impl

Browse source 
for ByteUnit type
This commit is contained in:
Xavier Moffett 2023-09-30 21:52:31 -04:00
parent 9bc0d7e758
commit 6d04507cb7
3 changed files with 26 additions and 62 deletions
Download patch file Download diff file Expand all files Collapse all files

62
src/lib.rs
View file

@ -26,41 +26,14 @@ simplebyteunit = "0.2.0"
Generate a human-readable, formatted ByteUnit:
```rust
use simplebyteunit::simplebyteunit::*;
let byteunit_var = 500000.to_byteunit(SI);
println!("{byteunit_var}");
assert_eq!(byteunit_var.to_string(), "500.00 kB");
```
Output:
```shell
500 kB
````
## Parsing strings into ByteUnits
And then you can parse formatted strings back into a ByteUnit
```rust
use simplebyteunit::simplebyteunit::*;
let byteunit_var: ByteUnit<i64> = "500 kB".into();
println!("{byteunit_var}");
```
Output:
```shell
500 kB
````
## Simple arithmetic operations
Addition, subtraction, multiplication, subtraction, and division are supported on this type.
@ -68,18 +41,10 @@ Addition, subtraction, multiplication, subtraction, and division are supported o
```rust
use simplebyteunit::simplebyteunit::*;
let a: ByteUnit<i64> = ByteUnit::SI(5000000);
let b: ByteUnit<i64> = ByteUnit::SI(5000000);
let byteunit_sum = a + b;
let a: ByteUnit<i64> = ByteUnit::SI(500000);
let b: ByteUnit<i64> = ByteUnit::SI(500000);
println!("{byteunit_sum}");
```
Output:
```shell
1.0 MB
assert_eq!(a + b, "1.0 MB".into());
```
## Equal/and/or operations
@ -91,17 +56,10 @@ use simplebyteunit::simplebyteunit::*;
let a: ByteUnit<i64> = "500 KiB".into();
let b: ByteUnit<i64> = "500 KiB".into();
let byteunit_bool = a == b;
println!("{byteunit_bool}");
assert_eq!(a == b, true);
```
Output:
```shell
true
````
Or operations are also supported on this type:
```rust
@ -109,17 +67,9 @@ use simplebyteunit::simplebyteunit::*;
let a: ByteUnit<i64> = 5000000.to_byteunit(IEC);
let b: ByteUnit<i64> = 5000000.to_byteunit(IEC);
let byteunit_bool = a >= b;
println!("{byteunit_bool}");
assert_eq!(a >= b, true);
```
Output:
```shell
true
```
*/
pub mod simplebyteunit;