https://github.com/al8n/flake
Distributed unique ID generator.
https://github.com/al8n/flake
distributed-id-generator rust-lang sonyflake unique-id unique-id-generator
Last synced: 2 months ago
JSON representation
Distributed unique ID generator.
- Host: GitHub
- URL: https://github.com/al8n/flake
- Owner: al8n
- License: apache-2.0
- Created: 2021-08-05T14:49:04.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-09-25T12:22:20.000Z (over 3 years ago)
- Last Synced: 2024-10-05T14:45:12.690Z (8 months ago)
- Topics: distributed-id-generator, rust-lang, sonyflake, unique-id, unique-id-generator
- Language: Rust
- Homepage:
- Size: 37.1 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README-zh_CN.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
Infallible-SonyFlake
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 [sony/sonyflake](https://github.com/sony/sonyflake), which is written in Go.
[
][Github-url]
[
](https://docs.rs/infallible-sonyflake)
[
][crates-url]
[
][CI-url]
[
][codecov-url]
[
][license-url]
[English](README.md) | 简体中文
A Sonyflake ID is composed of
```
39 bits for time in units of 10 msec
8 bits for a sequence number
16 bits for a machine id
```
Install
Add the following to your `Cargo.toml`:
```toml
[dependencies]
infallible-sonyflake = "0.1"
```
Quickstart
1. **Fallible SonyFlake**
`Sonyflake` may fail to generate a unique ID when we call `next_id` if time overflows.
```rust
use infallible_sonyflake::{SonyFlake, Settings};
use chrono::Utc;
fn main() {
let now = Utc::now();
let mut sf = Settings::new().set_start_time(now).into_sonyflake().unwrap();
let next_id = sf.next_id().unwrap();
println!("{}", next_id);
}
```
2. **Infallible SonyFlake**
`InfaillibleSonyFlake` will always generate a unique ID when we call `next_id` if time overflow happens, it will refresh the `start_time` to the current time.
```rust
use infallible_sonyflake::{InfallibleSonyFlake, Settings};
use chrono::Utc;
fn main() {
let now = Utc::now();
let mut sf = Settings::new().set_start_time(now).into_infallible_sonyflake().unwrap();
let next_id = sf.next_id();
println!("{}", next_id);
}
```
3. **Custom machine ID and machine ID checker**
```rust
use infallible_sonyflake::{InfallibleSonyFlake, Settings, MachineID, MachineIDChecker, IDParts, Error};
use chrono::Utc;
struct CustomMachineID {
counter: u64,
id: u16,
}
impl MachineID for CustomMachineID {
fn machine_id(&mut self) -> Result> {
self.counter += 1;
if self.counter % 2 != 0 {
Ok(self.id)
} else {
Err(Box::new("NaN".parse::().unwrap_err()))
}
}
}
struct CustomMachineIDChecker;
impl MachineIDChecker for CustomMachineIDChecker {
fn check_machine_id(&self, id: u16) -> bool {
if id % 2 != 0 {
true
} else {
false
}
}
}
fn main() {
let mut sf = Settings::new()
.set_machine_id(Box::new(CustomMachineID { counter: 0, id: 1 }))
.set_check_machine_id(Box::new(CustomMachineIDChecker {}))
.into_infallible_sonyflake().unwrap();
let id = sf.next_id();
let parts = IDParts::decompose(id);
assert_eq!(parts.get_machine_id(), 1);
let err = Settings::new()
.set_machine_id(Box::new(CustomMachineID { counter: 0, id: 2 }))
.set_check_machine_id(Box::new(CustomMachineIDChecker {}))
.into_infallible_sonyflake().unwrap_err();
assert_eq!(format!("{}", err), Error::InvalidMachineID(2).to_string());
}
```
License
Licensed under Apache License, Version
2.0.
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in this crate by you, as defined in the Apache-2.0 license.
[Github-url]: https://github.com/al8n/flake/
[CI-url]: https://github.com/al8n/flake/actions/workflows/ci.yml
[codecov-url]: https://app.codecov.io/gh/al8n/flake/
[license-url]: https://opensource.org/licenses/Apache-2.0
[crates-url]: https://crates.io/crates/infallible-sonyflake