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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
|
# human-format-rs
[](https://crates.io/crates/human_format) [](https://docs.rs/human_format)
Rust Port of human-format from node, formatting numbers for us, while the machines are still at bay.
| Branch | Linux/MacOS | Windows |
| :-- | :--: | :--: |
| Master | [](https://travis-ci.org/BobGneu/human-format-rs) | [](https://ci.appveyor.com/project/BobGneu/human-format-rs/branch/master) |
| Develop | [](https://travis-ci.org/BobGneu/human-format-rs) | [](https://ci.appveyor.com/project/BobGneu/human-format-rs/branch/develop) |
## What is human_format?
The primary purpose for this crate is to format numbers in a customizable fashion based around magnitudes. It is inspired by the [human-format](https://www.npmjs.com/package/human-format) package and the hope is to ultimately provide an idiomatic rust port.
## Usage
1. Add this package as a dependency
```toml
[dependencies]
human_format = "0.2"
```
2. Add the crate reference at your crate root
```rust
extern crate human_format;
```
3. Print some human readable strings
## Examples
```rust
// 1.00 k
Formatter::new()
.format(1000 as f64));
// 1.34 k
Formatter::new()
.with_decimals(2)
.format(1337 as f64);
// 1.3 k
Formatter::new()
.with_decimals(1)
.format(1337 as f64);
// 1.3B
Formatter::new()
.with_decimals(1)
.with_separator("")
.format(1337000000 as f64);
// 1.00 - k
Formatter::new()
.with_separator(" - ")
.format(1000 as f64);
// Define your own scales as you see fit
let mut custom_binary_scales = Scales::new();
custom_binary_scales
.with_base(1000)
.with_suffixes(["".to_owned(),"k".to_owned(), "M".to_owned(), "G".to_owned(), "T".to_owned(), "P".to_owned(), "E".to_owned(), "Z".to_owned(), "Y".to_owned()].to_vec());
// 1.00 kB
Formatter::new()
.with_scales(custom_binary_scales)
.with_units("B")
.format(1000 as f64);
// 1.00 kiB
Formatter::new()
.with_scales(Scales::Binary())
.with_units("B")
.format(1000 as f64);
```
For more examples please consult [tests/demo.rs](https://github.com/BobGneu/human-format-rs/blob/master/tests/demo.rs)
|
