Trait SnowflakeGenerator

pub trait SnowflakeGenerator<ID, T>
where
    ID: SnowflakeId,
    T: TimeSource<ID::Ty>,
{
    type Err: Debug;

    // Required methods
    fn new(machine_id: ID::Ty, clock: T) -> Self;
    fn next_id(&self) -> IdGenStatus<ID>;
    fn try_next_id(&self) -> Result<IdGenStatus<ID>, Self::Err>;
}

A minimal interface for generating Snowflake IDs

Required Associated Types

type Err: Debug

Required Methods

fn new(machine_id: ID::Ty, clock: T) -> Self

fn next_id(&self) -> IdGenStatus<ID>

Returns the next available ID

fn try_next_id(&self) -> Result<IdGenStatus<ID>, Self::Err>

A fallible version of Self::next_id that returns a Result.

Errors

• May return an error if the underlying generator uses a lock and it is poisoned.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl<ID, T> SnowflakeGenerator<ID, T> for AtomicSnowflakeGenerator<ID, T>

where ID: SnowflakeId<Ty = u64>, T: TimeSource<ID::Ty>,

type Err = Infallible

impl<ID, T> SnowflakeGenerator<ID, T> for BasicSnowflakeGenerator<ID, T>

where ID: SnowflakeId, T: TimeSource<ID::Ty>,

type Err = Infallible

impl<ID, T> SnowflakeGenerator<ID, T> for LockSnowflakeGenerator<ID, T>

where ID: SnowflakeId, T: TimeSource<ID::Ty>,

type Err = Error