Crates.io | sulid |
lib.rs | sulid |
version | 0.6.2 |
source | src |
created_at | 2024-09-07 06:25:48.965915 |
updated_at | 2024-09-07 10:06:36.585253 |
description | SULID is a unique ID generation algorithm that combines the benefits of ULID and Snowflake. |
homepage | |
repository | https://github.com/andeya/sulid |
max_upload_size | |
id | 1366963 |
size | 59,218 |
SULID is a unique ID generation algorithm that combines the benefits of ULID and Snowflake. It offers a highly efficient, reliable, and lexicographically sortable identifier, which ensures uniqueness across multiple data centers and machines, making it ideal for high-concurrency distributed environments.
SULID is based on the ULID (Universally Unique Lexicographically Sortable Identifier) format but incorporates additional bits for a data center ID and machine ID, similar to Snowflake. This design ensures uniqueness in distributed environments and maintains time-ordering characteristics, making it suitable for applications requiring both high concurrency and global uniqueness, such as microservice architectures, log tracking, and order generation.
SULIDs have a unique structure comprising the following parts, adding up to a 128-bit identifier:
Here is a visual breakdown of the SULID format:
| 48-bit Timestamp | 70-bit Random Number | 5-bit Data Center ID | 5-bit Machine ID |
Here is a visual breakdown of the SULID format:
| 48-bit Timestamp | 70-bit Random Number | 10-bit Worker ID |
To use SULID, add the following dependencies to your Cargo.toml
file:
[dependencies]
sulid = "0.6"
Here's how you can use the SulidGenerator
in your project:
use sulid::SulidGenerator;
fn main() {
let generator = SulidGenerator::v1_new(1, 1);
for _ in 0..3 {
let id = generator.generate();
println!("SULID-V1: {}", id);
}
let generator = SulidGenerator::v2_new(1);
for _ in 0..3 {
let id = generator.generate();
println!("SULID-V2: {}", id);
}
}
Running the example code generates SULIDs such as:
SULID-V1: 01J75Y6K09Q0VD4D7HCF496K11
SULID-V1: 01J75Y6K09ZGD0ATFGNJ7TWZ11
SULID-V1: 01J75Y6K09DWG2RPNEXNYSRP11
SULID-V2: 01J75Y6K09FVT8QTQVYGSDJ401
SULID-V2: 01J75Y6K0A16WE3XQN92QPP701
SULID-V2: 01J75Y6K0AN12FBKX56YGZF301
SULID leverages both ULID and Snowflake's strengths:
ULID
: Provides lexicographically sortable identifiers based on a timestamp and randomness.Snowflake
: Adds data center and machine IDs to ensure distributed uniqueness.By combining these two approaches, SULID generates IDs that are globally unique, time-ordered, and suitable for high-concurrency distributed environments.
This project is licensed under the MIT License.