Struct SnowflakeGenerator

pub struct SnowflakeGenerator {
    pub last_snowflake: Snowflake,
}

A snowflake generator that can be used to generate snowflake IDs.

Fields

last_snowflake: Snowflake

The last snowflake ID generated by the generator.

Implementations

impl SnowflakeGenerator

pub fn new(worker_id: u64) -> SnowflakeGenerator

Create a new snowflake generator with the given worker ID

Arguments

• worker_id - The worker ID of the snowflake generator

Returns

A new SnowflakeGenerator

Example

use rusty_snowflake::{SnowflakeGenerator, Snowflake};

const WORKER_ID: u64 = 420;

let generator = SnowflakeGenerator::new(WORKER_ID);

assert_eq!(generator.last_snowflake, Snowflake::new(WORKER_ID));

pub fn start_at(snowflake: &Snowflake) -> SnowflakeGenerator

Start at the given snowflake

Arguments

• snowflake - The snowflake to start at

Returns

A SnowflakeGenerator

Example

use rusty_snowflake::{Snowflake, SnowflakeGenerator};

const WORKER_ID: u64 = 420;

let generator = SnowflakeGenerator::start_at(&Snowflake::new(WORKER_ID));

assert_eq!(generator.last_snowflake, Snowflake::new(WORKER_ID));

pub fn next(&mut self) -> &Snowflake

Generates the next snowflake ID and returns a reference to it.

This method generates the next snowflake ID by updating the last_snowflake stored in the generator. It increments the sequence number and, if necessary, adjusts the timestamp to ensure uniqueness. The generated snowflake ID is then returned as a reference.

Examples

use rusty_snowflake::SnowflakeGenerator;

let mut generator = SnowflakeGenerator::new(420);

// Generate the next snowflake ID
let snowflake = generator.next();
println!("Generated snowflake ID: {:?}", snowflake);

Returns

A reference to the generated snowflake ID.

Panics

This method does not panic.

pub fn get_timestamp() -> u64

Get the current timestamp in seconds since the epoch (1970-01-01 00:00:00 UTC).

Returns

The current timestamp in seconds

pub fn wait_next_timestamp(last_timestamp: u64) -> u64

Wait for the next second and return the timestamp

Arguments

• current_timestamp - The current timestamp in seconds

Returns

The timestamp of the next second

Trait Implementations

impl Clone for SnowflakeGenerator

fn clone(&self) -> SnowflakeGenerator

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SnowflakeGenerator

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

Formats the value using the given formatter.

impl PartialEq for SnowflakeGenerator

fn eq(&self, other: &SnowflakeGenerator) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for SnowflakeGenerator

impl Eq for SnowflakeGenerator

impl StructuralPartialEq for SnowflakeGenerator