discord_snowflake

Struct SnowflakeGenerator

Source 
pub struct SnowflakeGenerator { /* private fields */ }
Expand description

A generator for Discord-compatible Snowflake IDs.

Implementations§

Source§

impl SnowflakeGenerator

Source

pub fn new(epoch: u64, worker_id: u64, process_id: u64) -> Self

Create a new Snowflake generator.

§Arguments
  • epoch - The epoch to use for the generator.
  • worker_id - The worker ID to use for the generator.
  • process_id - The process ID to use for the generator.
§Returns

A new Snowflake generator.

Source

pub fn generate(&mut self) -> Result<Snowflake, Error>

Generate a new Snowflake.

§Returns

A new Snowflake.

§Errors

This method will return an error if the current timestamp cannot be retrieved.

Source

pub fn must_generate(&mut self) -> Snowflake

Generate a new Snowflake, panicking if an error occurs.

§Returns

A new Snowflake.

§Panics

This method will panic if the current timestamp cannot be retrieved.

Trait Implementations§

Source§

impl Default for SnowflakeGenerator

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

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