summaryrefslogtreecommitdiffstats
path: root/third_party/rust/ordered-float/README.md
blob: 4ab4da22c3f05a15f80cad788ce97e37330141d6 (plain)
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
# Ordered Floats

Provides several wrapper types for Ord and Eq implementations on f64 and friends.

See the [API documentation](https://docs.rs/ordered-float) for further details.

## no_std

To use `ordered_float` without requiring the Rust standard library, disable
the default `std` feature:

```toml
[dependencies]
ordered-float = { version = "3.0", default-features = false }
```

## Optional features

The following optional features can be enabled in `Cargo.toml`:

* `bytemuck`: Adds implementations for traits provided by the `bytemuck` crate.
* `rand`: Adds implementations for various distribution types provided by the `rand` crate.
* `serde`: Implements the `serde::Serialize` and `serde::Deserialize` traits.
* `schemars`: Implements the `schemars::JsonSchema` trait.
* `proptest`: Implements the `proptest::Arbitrary` trait.
* `rkyv`: Implements `rkyv`'s `Archive`, `Serialize` and `Deserialize` traits.
* `speedy`: Implements `speedy`'s `Readable` and `Writable` traits.

## License

MIT