Struct Snowflake

Source
pub struct Snowflake(/* private fields */);
Expand description

Generated Snowflake

§Implementation

Let me describe snowflake ID (SID in below) in simple words.

Firstly, we have to know this structure of SID.

SIDs are actually i64 types. It’s length 64bit and 1bit for sign.

So it looks like this:

| sign |   data    | # sign not used.
| 1bit |   63bit   |

Next, I’ll introduce standard SID design to you. Why STANDARD? Because there are some variant, just ignore them use Twitter’s(formally X) design only.

The standard SID contains these content:

  • Timestamp: 41bit
  • Identifier(or Machine ID?): 10bit
  • Sequence Number: 12bit

Our SID structure looks like this

| sign |                data                      |
|   0  | Timestamp | Identifier | Sequence Number |
| 1bit |   41bit   |    10bit   |     12bit       |

✨ So cool, you in just understood the SID structure!

Ok, let’s deep in DARK.

§Timestamp

In standard design, timestamp can start at any time.

But here, the precision we need for the timestamp is to the millisecond, so exactly 41bits.

§Identifier

Base the design of distributed systems, we will have many machine(or instance) running at same time.

So we must distinguish between them. Based identifier have 10bit, we can have 1024 instance at same time, thats so cool!

§Sequence Number

Have you just noticed the Sequence Number? It have 12bit, means it can process at most 4096 message(or other things if you want) in one millisecond.

Above all, we can know: the entire system can produce at most 1024 * 4096 = 4194304 pieces of message at one millisecond!

§Out of assigned

But there is always the possibility that we will encounter a situation: all the SIDs for this millisecond have been assigned!

At this time, the instance must waiting for next millisecond. At next millisecond, we will have new 4096 SID can be assigned.

Methods from Deref<Target = i64>§

1.43.0 · Source

pub const MIN: i64 = -9_223_372_036_854_775_808i64

1.43.0 · Source

pub const MAX: i64 = 9_223_372_036_854_775_807i64

1.53.0 · Source

pub const BITS: u32 = 64u32

Trait Implementations§

Source§

impl AsRef<i64> for Snowflake

Source§

fn as_ref(&self) -> &i64

Converts this type into a shared reference of the (usually inferred) input type.
Source§

impl Clone for Snowflake

Source§

fn clone(&self) -> Snowflake

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Snowflake

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Deref for Snowflake

Source§

type Target = i64

The resulting type after dereferencing.
Source§

fn deref(&self) -> &Self::Target

Dereferences the value.
Source§

impl<'de> Deserialize<'de> for Snowflake

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl From<Snowflake> for i64

Source§

fn from(value: Snowflake) -> Self

Converts to this type from the input type.
Source§

impl Hash for Snowflake

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for Snowflake

Source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

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

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for Snowflake

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl PartialOrd for Snowflake

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

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

impl Serialize for Snowflake

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl Eq for Snowflake

Source§

impl StructuralPartialEq for Snowflake

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,