A library to asynchronously generate Snowflake IDs.
Snowflakes where developed by twitter for creating time sortable ids, which where able to be quickly generated without syncronisation even in distributed compute clusters.
Snowflakes have the following layout:
First you need to include dependencies. These are the recommended features. Tokio may be slimmed down by enabling individual features instead of full.
ignore
[dependencies]
hexafreeze = "0.1"
tokio = {version = "1", features = ["full"]}
[Generator] is the interface for the generation of snowflakes.
Snowflakes require an epoch, basically the start time of the Snowflake, it needs to be in the past, and less than ~ 69 years ago. [DEFAULT_EPOCH] should be fine for most applications until 2079.
It is thread-safe, therefore you do not need a Mutex to contain it.
It is recommend to use the same generator in all places in a rust application, something like once_cell may be useful for this.
```rust
use hexafreeze::Generator;
use hexafreeze::DEFAULT_EPOCH;
async fn main() {
// If your system is not distributed using 0 as the node_id is perfectly fine.
// The DEFAULT_EPOCH always needs to be dereferenced.
let gen = Generator::new(0, *DEFAULT_EPOCH).unwrap();
// The `generate` function is async and non-blocking.
let id: i64 = gen.generate().await.unwrap();
} ```