Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/houseme/snowflake-rs
A simple to use rust package to generate or parse Twitter snowflake IDs,generate time sortable 64 bits unique ids for distributed systems (inspired from twitter snowflake)
https://github.com/houseme/snowflake-rs
generator id random rust snowflake unique-id
Last synced: 10 days ago
JSON representation
A simple to use rust package to generate or parse Twitter snowflake IDs,generate time sortable 64 bits unique ids for distributed systems (inspired from twitter snowflake)
- Host: GitHub
- URL: https://github.com/houseme/snowflake-rs
- Owner: houseme
- License: apache-2.0
- Created: 2022-10-03T21:35:49.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-16T05:26:10.000Z (22 days ago)
- Last Synced: 2024-10-17T19:31:52.149Z (20 days ago)
- Topics: generator, id, random, rust, snowflake, unique-id
- Language: Rust
- Homepage: https://houseme.github.io/snowflake-rs/
- Size: 72.3 KB
- Stars: 9
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# Snowflake-rs
A simple to use rust package to generate or parse Twitter snowflake IDs, generate time sortable 64-bit unique ids for
distributed systems (inspired from twitter snowflake)
[](https://github.com/houseme/snowflake-rs/actions?query=workflow%3ABuild)
[](https://crates.io/crates/snowflake_me)
[](https://docs.rs/snowflake_me/)
[](LICENSE-APACHE)
A distributed unique ID generator inspired by [Twitter's Snowflake](https://blog.twitter.com/2010/announcing-snowflake).
This is a Rust implementation of the original [houseme/snowflake](https://github.com/houseme/snowflake), which is
written in Go.
A Snowflake ID is composed of
- 39 bits for time in units of 10 msec
- 8 bits for a sequence number
- 8 bits for a data center id
- 8 bits for a machine id
## Install
Add the following to your `Cargo.toml`:
```toml
[dependencies]
snowflake_me = "0.3"
```
## Quickstart
```rust
use snowflake_me::Snowflake;
let sf = Snowflake::new().unwrap();
let next_id = sf.next_id().unwrap();
println!("{}", next_id);
```
### Customize the start time
```rust
use snowflake_me::Snowflake;
use chrono::prelude::*;
let sf = Snowflake::builder().start_time(Utc::now()).finalize().unwrap();
let next_id = sf.next_id().unwrap();
println!("{}", next_id);
```
### Customize the machine ID
```rust
use snowflake_me::Snowflake;
let sf = Snowflake::builder().machine_id( & | | Ok(42)).finalize().unwrap();
let next_id = sf.next_id().unwrap();
println!("{}", next_id);
```
### Customize the datacenter ID
```rust
use snowflake_me::Snowflake;
let sf = Snowflake::builder().data_center_id( & | | Ok(42)).finalize().unwrap();
let next_id = sf.next_id().unwrap();
println!("{}", next_id);
```
### Resolve ID
```rust
use snowflake_me::{decompose, Snowflake};
let sf = Snowflake::new().unwrap();
let next_id = sf.next_id().unwrap();
let parts = decompose(next_id);
println!("timestamp: {}, machine_id: {}, sequence: {}, data_center_id:{}", parts.time, parts.machine_id, parts.sequence, parts.data_center_id);
```
## Benchmarks
Run them yourself with `cargo bench`.
#### 1, Benchmarks were run on a MacBook Pro (16-inch, 2019) with a 2,4GHz i9 and 64 GB memory.
```benchmark
test bench_decompose ... bench: 651 ns/iter (+/- 251)
test bench_new ... bench: 795,722 ns/iter (+/- 371,556)
test bench_next_id ... bench: 36,652 ns/iter (+/- 1,105)
```
#### 2, Benchmarks were run on a MacBook Pro (15-inch, 2017) with a 2,8GHz i7 and 16 GB memory.
```benchmark
test bench_decompose ... bench: 1,066 ns/iter (+/- 132)
test bench_new ... bench: 738,129 ns/iter (+/- 318,192)
test bench_next_id ... bench: 37,390 ns/iter (+/- 499)
```
## License
Licensed under either of
* Apache License, Version 2.0, [LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0
* MIT license [LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT
at your option.
## Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as
defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.