Struct snowflaked::Builder

pub struct Builder { /* private fields */ }

A builder for a snowflake Generator. This builder can be used for both Generator and sync::Generator.

Implementations

impl Builder

pub const fn new() -> Self

Creates a new Builder with the instance set to 0 and epoch set to UNIX_EPOCH.

Examples

let generator: Generator = Builder::new().build();

assert_eq!(generator.instance(), 0);
assert_eq!(generator.epoch(), UNIX_EPOCH);

pub const fn instance(self, instance: u16) -> Self

Sets the instance value of the Builder.

Panics

Panics if the provided instance exceeds the maximum value (2^10 -1).

Examples

let generator: Generator = Builder::new().instance(400).build();

assert_eq!(generator.instance(), 400);

Providing an invalid instance panics:

let generator: Generator = Builder::new().instance(5000).build();

pub const fn instance_checked(self, instance: u16) -> Option<Self>

Sets the instance value of the Builder. Returns None if the provided instance exceeds the maximum value (2^10 -1).

Examples

let builder = Builder::new().instance_checked(400);
assert!(builder.is_some());

Providing an invalid instance returns None:

let builder = Builder::new().instance_checked(5000);
assert!(builder.is_none());

pub const fn instance_unchecked(self, instance: u16) -> Self

Sets the instance value of the Builder without validating whether instance exceeds the maximum value (2^10 - 1).

Examples

let generator: Generator = Builder::new().instance_unchecked(400).build();

assert_eq!(generator.instance(), 400);

pub const fn epoch(self, epoch: SystemTime) -> Self

pub fn build<T>(self) -> T

where T: From<Self>,

Consumes this Builder, returning the constructed generator. This function works with both Generator and sync::Generator.

Examples

use snowflaked::{Builder, Generator};

let mut generator = Builder::new().build::<Generator>();

let id: u64 = generator.generate();

A sync::Generator can be constructed in the same way:

use snowflaked::Builder;
use snowflaked::sync::Generator;

let generator = Builder::new().build::<Generator>();

let id: u64 = generator.generate();

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.

impl From<Builder> for Generator

Available on crate feature sync only.

fn from(builder: Builder) -> Self

Converts to this type from the input type.

impl From<Builder> for Generator

fn from(builder: Builder) -> Self

Converts to this type from the input type.

impl Copy for Builder