Struct Snowflake 

pub struct Snowflake { /* private fields */ }

Available on crate feature snowflake only.

Snowflake ID generator.

Holds the worker ID and the running sequence counter.

Example

use id_forge::snowflake::Snowflake;

let mut gen = Snowflake::new(1);
let id = gen.next_id();

Implementations

impl Snowflake

pub fn new(worker_id: u16) -> Self

Build a new generator with the given worker ID (0-1023) and the default epoch.

Examples found in repository

examples/basic.rs (line 18)

fn main() {
    let v4 = Uuid::v4();
    println!("UUID v4:    {v4} (version={})", v4.version());
    println!("UUID v7:    {}", Uuid::v7());
    println!("UUID nil:   {}", Uuid::nil());

    let a = Ulid::new();
    let b = Ulid::new();
    println!("ULID a:     {a}");
    println!("ULID b:     {b} (monotonic: {})", b > a);

    let gen = Snowflake::new(1);
    println!("Snowflake:  {}", gen.next_id());

    println!("NanoID 21:  {}", nanoid::generate());
    println!("NanoID 8:   {}", nanoid::with_length(8));

    assert_eq!(v4, Uuid::parse_str(&v4.to_string()).unwrap());
    assert_eq!(a, Ulid::parse_str(&a.to_string()).unwrap());
}

pub fn with_epoch(worker_id: u16, epoch_ms: u64) -> Self

Build a new generator with a custom epoch.

pub fn next_id(&self) -> u64

Generate the next ID.

In 0.1.0 this is a placeholder. The real per-millisecond sequence-rollover logic lands in 0.9.x.

Examples found in repository

examples/basic.rs (line 19)

fn main() {
    let v4 = Uuid::v4();
    println!("UUID v4:    {v4} (version={})", v4.version());
    println!("UUID v7:    {}", Uuid::v7());
    println!("UUID nil:   {}", Uuid::nil());

    let a = Ulid::new();
    let b = Ulid::new();
    println!("ULID a:     {a}");
    println!("ULID b:     {b} (monotonic: {})", b > a);

    let gen = Snowflake::new(1);
    println!("Snowflake:  {}", gen.next_id());

    println!("NanoID 21:  {}", nanoid::generate());
    println!("NanoID 8:   {}", nanoid::with_length(8));

    assert_eq!(v4, Uuid::parse_str(&v4.to_string()).unwrap());
    assert_eq!(a, Ulid::parse_str(&a.to_string()).unwrap());
}

Trait Implementations

impl Debug for Snowflake

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.