Struct SnowflakeDiscordId

pub struct SnowflakeDiscordId { /* private fields */ }

A 64-bit Snowflake ID using the Discord layout

• 42 bits timestamp (ms since DISCORD_EPOCH)
• 10 bits machine ID (worker ID (5) and process ID (5))
• 12 bits sequence

 Bit Index:  63             22 21             12 11             0
             +----------------+-----------------+---------------+
 Field:      | timestamp (42) | machine ID (10) | sequence (12) |
             +----------------+-----------------+---------------+
             |<----- MSB ---------- 64 bits --------- LSB ----->|

Implementations

impl SnowflakeDiscordId

pub const RESERVED_BITS: u64 = 0u64

pub const TIMESTAMP_BITS: u64 = 42u64

pub const MACHINE_ID_BITS: u64 = 10u64

pub const SEQUENCE_BITS: u64 = 12u64

pub const SEQUENCE_SHIFT: u64 = 0u64

pub const MACHINE_ID_SHIFT: u64 = 12u64

pub const TIMESTAMP_SHIFT: u64 = 22u64

pub const RESERVED_SHIFT: u64 = 64u64

pub const RESERVED_MASK: u64 = 0u64

pub const TIMESTAMP_MASK: u64 = 4_398_046_511_103u64

pub const MACHINE_ID_MASK: u64 = 1_023u64

pub const SEQUENCE_MASK: u64 = 4_095u64

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 const fn max_timestamp() -> u64

Returns the maximum representable timestamp value based on Self::TIMESTAMP_BITS.

pub const fn max_machine_id() -> u64

Returns the maximum representable machine ID value based on Self::MACHINE_ID_BITS.

pub const fn max_sequence() -> u64

Returns the maximum representable sequence value based on Self::SEQUENCE_BITS.

pub const fn to_raw(&self) -> u64

Converts this type into its raw type representation

pub const fn from_raw(raw: u64) -> Self

Converts a raw type into this type

Trait Implementations

impl Clone for SnowflakeDiscordId

fn clone(&self) -> SnowflakeDiscordId

Returns a duplicate 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 Display for SnowflakeDiscordId

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

Formats the value using the given formatter.

impl FromStr for SnowflakeDiscordId

type Err = Error<SnowflakeDiscordId>

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

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 Id for SnowflakeDiscordId

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

const ZERO: u64 = 0u64

Zero value (used for resetting the sequence)

const ONE: u64 = 1u64

One value (used for incrementing the sequence)

type Ty = u64

Scalar type for all bit fields (typically u64 or u128)

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 SnowflakeId for SnowflakeDiscordId

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

Returns the timestamp portion of the ID.

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

Returns the machine ID portion of the ID.

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

Returns the sequence portion of the ID.

fn max_timestamp() -> Self::Ty

Returns the maximum possible value for the timestamp field.

fn max_machine_id() -> Self::Ty

Returns the maximum possible value for the machine_id field.

fn max_sequence() -> Self::Ty

Returns the maximum possible value for the sequence field.

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

Constructs a new Snowflake ID from its components.

fn is_valid(&self) -> bool

Returns true if the ID’s internal structure is valid, such as reserved bits being unset or fields within expected ranges.

fn into_valid(self) -> Self

Returns a normalized version of the ID with any invalid or reserved bits cleared. This guarantees a valid, canonical representation.

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 TryFrom<&str> for SnowflakeDiscordId

type Error = Error<SnowflakeDiscordId>

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for SnowflakeDiscordId

impl Eq for SnowflakeDiscordId

impl StructuralPartialEq for SnowflakeDiscordId