Struct rusty_snowflake::Snowflake

pub struct Snowflake {
    pub worker_id: u64,
    pub sequence: u64,
    pub last_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).

last_timestamp: u64

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

Implementations

impl Snowflake

pub fn new(worker_id: u64) -> Snowflake

pub fn next(&mut self) -> u64

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.

Example

use rusty_snowflake::Snowflake;

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

pub fn to_id(&self) -> u64

Convert a snowflake ID into a u64

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 mut snowflake = Snowflake::new(1);

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

assert_eq!(snowflake, parsed);

Trait Implementations

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 PartialEq<Snowflake> for Snowflake

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for Snowflake

impl StructuralEq for Snowflake

impl StructuralPartialEq for Snowflake