# Units [kept small and simple][wikipedia/kiss-principle]

[![Build Status nightly][github/self/actions/badge]][github/self/actions]

[![Tag][github/self/tags/badge]][github/self/tags]
[![Crates.io][crates.io/self/badge]][crates.io/self]
[![Docs][docs.rs/self/badge]][docs.rs/self]

[![Changelog][github/self/blob/changelog/badge]][github/self/blob/changelog]
[![Last commit][github/self/last-commit/badge]][github/self/last-commit]

[![License][github/self/license/badge]][github/self/license]

Welcome! `:)`
Goal of this repo is to provide a simple and explicit implementation of units, without specialties or complex/implicit behaviour.

An example, including an example for forbidden implicit behaviour, is the following code-snippet:

```rust
use kissunits::{
    distance::{Kilometers, Meters},
    time::{Hours, Seconds},
};

fn main() {
    // use the struct directly
    let m = Meters(72_000.0);
    let h = Hours(2.0);

    // compile-error since resulting unit is not clear
    println!("{}", m / h); // ERROR

    // prints 36 km/h
    let km = Kilometers::from(m);
    println!("{} / {} = {}", km, h, km / h);

    // prints 10 m/s
    let s = Seconds::from(h);
    println!("{} / {} = {}", m, s, m / s);
}
```

One could argue, that the resulting type could be specified explicitly, like

```rust
let mps: MetersPerSecond = m / h;
```

but this would lead to implicit rounding errors.


## Setup and usage

Rust has a build-tool called `cargo`, which can be used to run everything except scripts in `scripts/`.

```zsh
# Just executing some easy cargo-build-commands
./scripts/build.sh
# Run the example
cargo run --example basic
```


## Credits

The project started in the early 2020.
This section honors the workers and helpers of this project, sorted by their last names.

__[Dominic Parga Cacheiro][github/dominicparga]__  
has written these units.


[crates.io/self]: https://crates.io/crates/kissunits
[crates.io/self/badge]: https://img.shields.io/crates/v/kissunits?style=for-the-badge
[docs.rs/self]: https://docs.rs/kissunits/
[docs.rs/self/badge]: https://img.shields.io/crates/v/kissunits?color=informational&label=docs&style=for-the-badge
[github/dominicparga]: https://github.com/dominicparga
[github/lesstat/cyclops/blob/README]: https://github.com/Lesstat/cyclops/blob/master/README.md#graph-data
[github/lesstat/multi-ch-constructor]: https://github.com/Lesstat/multi-ch-constructor
[github/lesstat/multi-ch-constructor/change-dim]: https://github.com/Lesstat/multi-ch-constructor/blob/bec548c1a1ebeae7ac19d3250d5473199336d6fe/src/multi_lib/graph.hpp#L49
[github/self/actions]: https://github.com/dominicparga/kissunits/actions
[github/self/actions/badge]: https://img.shields.io/github/workflow/status/dominicparga/kissunits/Rust?label=nightly-build&style=for-the-badge
[github/self/blob/changelog]: https://github.com/dominicparga/kissunits/blob/nightly/CHANGELOG.md
[github/self/blob/changelog/badge]: https://img.shields.io/badge/CHANGELOG-nightly-blueviolet?style=for-the-badge
[github/self/last-commit]: https://github.com/dominicparga/kissunits/commits
[github/self/last-commit/badge]: https://img.shields.io/github/last-commit/dominicparga/kissunits?style=for-the-badge
[github/self/license]: https://github.com/dominicparga/kissunits/blob/nightly/LICENSE.md
[github/self/license/badge]: https://img.shields.io/badge/license-Apache--2.0-green?style=for-the-badge
[github/self/tags]: https://github.com/dominicparga/kissunits/tags
[github/self/tags/badge]: https://img.shields.io/github/v/tag/dominicparga/kissunits?sort=semver&style=for-the-badge
[github/self/tree/examples]: https://github.com/dominicparga/kissunits/tree/nightly/examples
[github/self/wiki/usage]: https://github.com/dominicparga/kissunits/wiki/Usage
[github/servo/rust-smallvec]: https://github.com/servo/rust-smallvec
[wikipedia/kiss-principle]: https://en.wikipedia.org/wiki/KISS_principle