convert-units 0.1.0

Convert between units of measurement (length, mass, volume, temperature, time, digital, ...) with a fluent API. A faithful port of the convert-units 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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88

# convert-units

[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)

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

**Convert between units of measurement** — length, area, mass, volume, temperature, time,
digital, speed, pressure, energy, power, frequency, angle, and more (**23 measures, 185
units**), with a fluent API.

A faithful Rust port of the popular
[`convert-units`](https://www.npmjs.com/package/convert-units) npm package.

- **Zero dependencies**
- `to_best` to pick the most readable unit
- `describe`, `list`, `measures`, and `possibilities` introspection
- Differential-tested against the reference `convert-units` implementation (all 185 × 185
  unit pairs)

## Install

```toml
[dependencies]
convert-units = "0.1"
```

## Usage

```rust
use convert_units::convert;

assert_eq!(convert(1.0).from("kg").unwrap().to("lb").unwrap(), 2.2046244201837775);
assert_eq!(convert(100.0).from("cm").unwrap().to("m").unwrap(), 1.0);
assert_eq!(convert(0.0).from("C").unwrap().to("F").unwrap(), 32.0);
assert_eq!(convert(1.0).from("GB").unwrap().to("MB").unwrap(), 1024.0);

// Cross-measure conversions are rejected:
assert!(convert(1.0).from("kg").unwrap().to("m").is_err());
```

Pick the most appropriate unit:

```rust
use convert_units::convert;

let best = convert(12000.0).from("mm").unwrap().to_best().unwrap();
assert_eq!((best.val, best.unit), (12.0, "m"));
```

Introspect the available units:

```rust
use convert_units::{convert, describe, measures, list};

assert_eq!(describe("kg").unwrap().singular, "Kilogram");
assert_eq!(measures().len(), 23);
assert_eq!(list(Some("length")).len(), 9);
assert_eq!(convert(1.0).from("kg").unwrap().possibilities(), ["mcg", "mg", "g", "kg", "mt", "oz", "lb", "t"]);
```

## Contributors ✨

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind are welcome — code, docs, bug reports, ideas, reviews! See the [emoji key](https://allcontributors.org/docs/en/emoji-key) for how each contribution is recognized, and open a PR or issue to get involved.

Thanks goes to these wonderful people:

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
  <tbody>
    <tr>
      <td align="center" valign="top" width="14.28%"><a href="https://github.com/trananhtung"><img src="https://avatars.githubusercontent.com/u/30992229?v=4?s=100" width="100px;" alt="Tung Tran"/><br /><sub><b>Tung Tran</b></sub></a><br /><a href="https://github.com/trananhtung/./commits?author=trananhtung" title="Code">💻</a> <a href="#maintenance-trananhtung" title="Maintenance">🚧</a></td>
    </tr>
  </tbody>
</table>

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->

<!-- ALL-CONTRIBUTORS-LIST:END -->

## License

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