Struct Snowflake

pub struct Snowflake {
    pub worker_id: u64,
    pub sequence: u64,
    pub timestamp: u64,
}

Fields

worker_id: u64

The worker ID of the snowflake. This is a unique identifier for the host or thread that created the snowflake.

sequence: u64

The sequence number of the snowflake. This increments every time the snowflake is created within the same second. This will automatically reset to 0 when the timestamp changes or when the sequence overflows (2^16 - 1).

timestamp: u64

The timestamp of the snowflake creation in seconds since the epoch (1970-01-01 00:00:00 UTC).

Implementations

impl Snowflake

pub fn new(worker_id: u64) -> Snowflake

Create a new snowflake with the given worker ID

Arguments

• worker_id - The worker ID of the snowflake

Returns

A new Snowflake

Example

use rusty_snowflake::Snowflake;

let snowflake = Snowflake::new(420);

pub fn next(&self) -> Snowflake

Generate a new snowflake ID This function will return a new snowflake ID every time it is called with the same worker ID. If the timestamp is the same as the previous call, the sequence number will be incremented.

Returns

A new snowflake ID

Example

use rusty_snowflake::Snowflake;

let snowflake = Snowflake::new(420);
let next = snowflake.next();
println!("{}", next);
println!("{}", next.next());

pub fn to_id(&self) -> u64

Convert a Snowflake ID into a u64 id

Example

use rusty_snowflake::Snowflake;

let snowflake = Snowflake::new(1); // Create

let id = snowflake.to_id();

let parsed = Snowflake::parse(id);

assert_eq!(snowflake, parsed);

pub fn parse(id: u64) -> Snowflake

Parse a snowflake ID into a Snowflake

Example

use rusty_snowflake::Snowflake;

let snowflake = Snowflake::new(1);

let id = snowflake.to_id();
let parsed = Snowflake::parse(id);

assert_eq!(snowflake, parsed);

Trait Implementations

impl Clone for Snowflake

fn clone(&self) -> Snowflake

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Snowflake

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

Formats the value using the given formatter.

impl Display for Snowflake

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

Display the Snowflake

Example

use rusty_snowflake::Snowflake;

let mut snowflake = Snowflake::new(1);
println!("{}", snowflake); // u64 ID

impl From<u64> for Snowflake

fn from(id: u64) -> Snowflake

Converts to this type from the input type.

impl Ord for Snowflake

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Snowflake

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

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

const 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 PartialOrd for Snowflake

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Snowflake

impl Eq for Snowflake

impl StructuralPartialEq for Snowflake