ckey 0.2.1

CKey is a consistent hash key library.
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

# CKey

[CKey](https://gitlab.com/ufoot/ckey) is an experimental consistent hash key library, implemented in [Rust](https://www.rust-lang.org/).

See the [theory about consistent hashing](https://en.wikipedia.org/wiki/Consistent_hashing).

This library provides 256-bit keys, with some helpers.
Internally, keys are stored on 4 unsigned integers of 64-bit each.

![CKey icon](https://gitlab.com/ufoot/ckey/raw/main/media/ckey-256x256.jpg)

# Status

For now this is a toy project, clearly *NOT* suitable for production use.

[![Build Status](https://gitlab.com/ufoot/ckey/badges/main/pipeline.svg)](https://gitlab.com/ufoot/ckey/pipelines)

# Usage

```rust
use ckey::CKey;

let k1 = CKey::rand();
let k2 = k1.next();
let k3 = k2 + 10u8;
assert!(k2.inside(k1, k3));
let k4 = CKey::from(1000u16);
assert_eq!("0.015258789", format!("{}", k4));
```

# Links

* [crate](https://crates.io/crates/ckey) on crates.io
* [doc](https://docs.rs/ckey/) on docs.rs
* [source](https://gitlab.com/ufoot/ckey/tree/main) on gitlab.com

# License

Ckey is licensed under the [MIT](https://gitlab.com/ufoot/ckey/blob/main/LICENSE) license.