SnowflakeIdGenerator

Struct SnowflakeIdGenerator 

Source
pub struct SnowflakeIdGenerator {
    pub machine_id: i32,
    pub node_id: i32,
    /* private fields */
}
Expand description

The SnowflakeIdGenerator type is snowflake algorithm wrapper.

Fields§

§machine_id: i32

machine_id, is use to supplement id machine or sectionalization attribute.

§node_id: i32

node_id, is use to supplement id machine-node attribute.

Implementations§

Source§

impl SnowflakeIdGenerator

Source

pub fn new(machine_id: i32, node_id: i32) -> SnowflakeIdGenerator

Constructs a new SnowflakeIdGenerator using the UNIX epoch. Please make sure that machine_id and node_id is small than 32(2^5);

§Examples
use snowflake::SnowflakeIdGenerator;

let id_generator = SnowflakeIdGenerator::new(1, 1);
Source

pub fn with_epoch( machine_id: i32, node_id: i32, epoch: SystemTime, ) -> SnowflakeIdGenerator

Constructs a new SnowflakeIdGenerator using the specified epoch. Please make sure that machine_id and node_id is small than 32(2^5);

§Examples
use std::time::{Duration, UNIX_EPOCH};
use snowflake::SnowflakeIdGenerator;

// 1 January 2015 00:00:00
let discord_epoch = UNIX_EPOCH + Duration::from_millis(1420070400000);
let id_generator = SnowflakeIdGenerator::with_epoch(1, 1, discord_epoch);
Source

pub fn real_time_generate(&mut self) -> i64

The real_time_generate keep id generate time is eq call method time.

§Examples
use snowflake::SnowflakeIdGenerator;

let mut id_generator = SnowflakeIdGenerator::new(1, 1);
id_generator.real_time_generate();
Source

pub fn generate(&mut self) -> i64

The basic guarantee time punctuality.

Basic guarantee time punctuality. sometimes one millis can’t use up 4096 ID, the property of the ID isn’t real-time. But setting time after every 4096 calls.

§Examples
use snowflake::SnowflakeIdGenerator;

let mut id_generator = SnowflakeIdGenerator::new(1, 1);
id_generator.generate();
Source

pub fn lazy_generate(&mut self) -> i64

The lazy generate.

Lazy generate. Just start time record last_time_millis it consume every millis ID. Maybe faster than standing time.

§Examples
use snowflake::SnowflakeIdGenerator;

let mut id_generator = SnowflakeIdGenerator::new(1, 1);
id_generator.lazy_generate();

Trait Implementations§

Source§

impl Clone for SnowflakeIdGenerator

Source§

fn clone(&self) -> SnowflakeIdGenerator

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 SnowflakeIdGenerator

Source§

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

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

impl Copy for SnowflakeIdGenerator

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<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.