pretty-ms 0.1.0

Convert milliseconds to a human-readable string: 1337000000 -> "15d 11h 23m 20s". A faithful port of the pretty-ms npm package. Zero dependencies.
Documentation 
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

# pretty-ms

[![Crates.io](https://img.shields.io/crates/v/pretty-ms.svg)](https://crates.io/crates/pretty-ms)
[![Documentation](https://docs.rs/pretty-ms/badge.svg)](https://docs.rs/pretty-ms)
[![CI](https://github.com/trananhtung/pretty-ms/actions/workflows/ci.yml/badge.svg)](https://github.com/trananhtung/pretty-ms/actions/workflows/ci.yml)
[![License](https://img.shields.io/crates/l/pretty-ms.svg)](#license)

**Convert milliseconds to a human-readable string** — `1337000000` → `"15d 11h 23m
20s"`. A faithful Rust port of the [`pretty-ms`](https://www.npmjs.com/package/pretty-ms)
npm package, with the same options. Zero dependencies.

```rust
use pretty_ms::{pretty_ms, Options};

assert_eq!(pretty_ms(1_337_000_000.0, &Options::default()), "15d 11h 23m 20s");
assert_eq!(pretty_ms(1337.0, &Options::default()), "1.3s");
assert_eq!(pretty_ms(1000.0, &Options::default().verbose(true)), "1 second");
assert_eq!(pretty_ms(95_500.0, &Options::default().colon_notation(true)), "1:35.5");
```

There is also a [`Duration`](https://doc.rust-lang.org/std/time/struct.Duration.html)
wrapper:

```rust
use std::time::Duration;
use pretty_ms::{pretty_duration, Options};

assert_eq!(pretty_duration(Duration::from_secs(90), &Options::default()), "1m 30s");
```

## Why pretty-ms?

Showing a raw millisecond count to a human is unfriendly. This turns it into the
familiar `15d 11h 23m 20s` (or `15:11:23:20`, or `15 days …`), matching the
ubiquitous JS library's output exactly — handy when you want parity with a
JavaScript front-end, or just a well-tested, option-rich duration formatter.

```toml
[dependencies]
pretty-ms = "0.1"
```

## Options

Build with [`Options::default()`] and chain the setters:

| Option | Effect |
| --- | --- |
| `compact` | Only the first unit: `1h 10m` → `1h` |
| `unit_count(n)` | Show at most `n` units |
| `verbose` | Long unit names: `5h 1m` → `5 hours 1 minute` |
| `colon_notation` | `5h 1m 45s` → `5:01:45` |
| `seconds_decimal_digits(n)` | Fraction digits on seconds (default `1`) |
| `milliseconds_decimal_digits(n)` | Fraction digits on milliseconds (default `0`) |
| `keep_decimals_on_whole_seconds` | `3s` → `3.0s` |
| `separate_milliseconds` | `1s 51ms` instead of `1.05s` |
| `format_sub_milliseconds` | Show `µs` and `ns` |
| `hide_year` / `hide_year_and_days` / `hide_seconds` | Drop those units |

```rust
use pretty_ms::{pretty_ms, Options};

assert_eq!(pretty_ms(1_337_000_000.0, &Options::default().compact(true)), "15d");
assert_eq!(pretty_ms(1010.0, &Options::default().separate_milliseconds(true)), "1s 10ms");
assert_eq!(pretty_ms(100.4, &Options::default().format_sub_milliseconds(true)), "100ms 400µs");
```

Negative values get a leading `-`, and a non-finite input is treated as `0`.

## License

Licensed under either of [Apache-2.0](LICENSE-APACHE) or [MIT](LICENSE-MIT) at
your option.