Struct SnowflakeDiscordId

pub struct SnowflakeDiscordId { /* private fields */ }

A 64-bit Snowflake ID using the Discord layout

NOTE: To keep the API the same, we’re collapsing their notation of machine and process id into the same number of bits.

• 42 bits timestamp (ms since Discord epoch: Jan 1, 2015 UTC)
• 10 bits internal worker ID (5) and process ID (5), combined into machine_id (10)
• 12 bits increment

| timestamp (42) | machine_id (10) | sequence (12) |

Implementations

impl SnowflakeDiscordId

pub const TIMESTAMP_MASK: u64 = 4_398_046_511_103u64

Bitmask for extracting the 42-bit timestamp field from a packed ID. Occupies bits 22 through 63 (most significant bits).

pub const MACHINE_ID_MASK: u64 = 1_023u64

Bitmask for extracting the 10-bit machine ID field. Occupies bits 12 through 21.

pub const SEQUENCE_MASK: u64 = 4_095u64

Bitmask for extracting the 12-bit sequence field. Occupies bits 0 through 11.

pub const TIMESTAMP_SHIFT: u64 = 22u64

Number of bits to shift the timestamp to its correct position (starting at bit 22).

pub const MACHINE_ID_SHIFT: u64 = 12u64

Number of bits to shift the process/machine ID to its correct position.

pub const SEQUENCE_SHIFT: u64 = 0u64

Number of bits to shift the sequence field (starts at the least significant bit).

pub const fn from(timestamp: u64, machine_id: u64, sequence: u64) -> Self

pub const fn timestamp(&self) -> u64

Extracts the timestamp from the packed ID.

pub const fn machine_id(&self) -> u64

Extracts the machine ID from the packed ID.

pub const fn sequence(&self) -> u64

Extracts the sequence number from the packed ID.

pub fn to_padded_string(&self) -> String

Returns the ID as a zero-padded 20-digit string.

Trait Implementations

impl Base32 for SnowflakeDiscordId

fn encode(&self) -> String

fn decode(s: &str) -> Result<Self>

impl Clone for SnowflakeDiscordId

fn clone(&self) -> SnowflakeDiscordId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SnowflakeDiscordId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SnowflakeDiscordId

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SnowflakeDiscordId

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

Formats the value using the given formatter.

impl Hash for SnowflakeDiscordId

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for SnowflakeDiscordId

fn cmp(&self, other: &SnowflakeDiscordId) -> 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 SnowflakeDiscordId

fn eq(&self, other: &SnowflakeDiscordId) -> 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 PartialOrd for SnowflakeDiscordId

fn partial_cmp(&self, other: &SnowflakeDiscordId) -> 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 Serialize for SnowflakeDiscordId

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Snowflake for SnowflakeDiscordId

const ZERO: Self::Ty = {transmute(0x0000000000000000): <id::SnowflakeDiscordId as id::Snowflake>::Ty}

Zero value (used for resetting the sequence)

const ONE: Self::Ty = {transmute(0x0000000000000001): <id::SnowflakeDiscordId as id::Snowflake>::Ty}

One value (used for incrementing the sequence)

type Ty = u64

Scalar type for all bit fields (typically u64)

fn timestamp(&self) -> Self::Ty

Returns the timestamp portion of the ID.

fn max_timestamp() -> Self::Ty

Returns the maximum possible value for the timestamp field.

fn machine_id(&self) -> Self::Ty

Returns the machine ID portion of the ID.

fn max_machine_id() -> Self::Ty

Returns the maximum possible value for the machine_id field.

fn sequence(&self) -> Self::Ty

Returns the sequence portion of the ID.

fn max_sequence() -> Self::Ty

Returns the maximum possible value for the sequence field.

fn from_components( timestamp: Self::Ty, machine_id: Self::Ty, sequence: Self::Ty, ) -> Self

Constructs a new Snowflake ID from its components.

fn to_raw(&self) -> Self::Ty

Converts this type into its raw type representation

fn from_raw(raw: Self::Ty) -> Self

Converts a raw type into this type

fn to_padded_string(&self) -> String

fn has_sequence_room(&self) -> bool

Returns true if the current sequence value can be incremented.

fn next_sequence(&self) -> Self::Ty

Returns the next sequence value.

fn increment_sequence(&self) -> Self

Returns a new ID with the sequence incremented.

fn rollover_to_timestamp(&self, ts: Self::Ty) -> Self

Returns a new ID for a newer timestamp with sequence reset to zero.

impl Copy for SnowflakeDiscordId

impl Eq for SnowflakeDiscordId

impl StructuralPartialEq for SnowflakeDiscordId