Rust binding to HdrHistogram_c library
======================================
This is a thin binding to the [HdrHistogram_c](https://github.com/HdrHistogram/HdrHistogram_c)
library, itself a port of [HdrHistogram](http://hdrhistogram.org/). Aside from the normal Rust
safety features, the main embellishment is an implementation of the Iterator trait for the various
ways to iterate the histogram.
It also uses `u64` instead of a signed type for values, as the library does not allow values to be
less than 1. However it also means that any value greater than 2^63 will be treated as negative and
rejected.
I've re-implemented the test suite in Rust (cargo test) to exercise the API, and it all passes.
TODO:
* Finish basic API
* Complete iterator items
* anything missing
Prerequisites
-------------
First install [HdrHistogram_c](https://github.com/HdrHistogram/HdrHistogram_c):
```sh
$ git clone https://github.com/HdrHistogram/HdrHistogram_c
$ cd HdrHistogram_c
$ cmake -D CMAKE_BUILD_TYPE=release .
$ make
# make install
```
You may need to run ldconfig after installing to make sure the installed library is found properly.
Use
---
This is on crates.io, so using it is just a matter of adding this to your Cargo.toml:
```
[dependencies]
hdrhistogram = "*"
```
The API is not at all stable right now.
Documentation
-------------
Docs are hosted [here](https://jsgf.github.io/hdrhistogram/).
Jeremy Fitzhardinge <jeremy@goop.org>