snowgleam

A module for generating unique IDs using the Twitter Snowflake algorithm.

Types

Generator

opaque </>

The Snowflake ID generator. This is not meant to be used directly but with the provided builder functions.

pub opaque type Generator

Message

opaque </>

The messages that the generator actor can receive.

pub opaque type Message

Constants

default_epoch

</>

pub const default_epoch: Int

The default epoch for the generator. Corresponds to the Unix epoch.

Functions

generate

</>

pub fn generate(channel: Subject(Message)) -> Int

Generates a new Snowflake ID.

Examples

import gleam/snowgleam

let epoch = 1_420_070_400_000
let worker_id = 12

let assert Ok(generator) =
  snowgleam.new_generator()
  |> snowgleam.with_epoch(epoch)
  |> snowgleam.with_worker_id(worker_id)
  |> snowgleam.start()

let id = snowgleam.generate(generator)

new_generator

</>

pub fn new_generator() -> Generator

Creates a new Snowflake ID generator with default settings.

process_id

</>

pub fn process_id(id: Int) -> Int

Extracts the process ID from a Snowflake ID.

start

</>

pub fn start(
  generator: Generator,
) -> Result(Subject(Message), String)

Starts the generator.

timestamp

</>

pub fn timestamp(id: Int, epoch: Int) -> Int

Extracts the timestamp from a Snowflake ID using the provided epoch.

with_epoch

</>

pub fn with_epoch(generator: Generator, epoch: Int) -> Generator

Sets the epoch for the generator.

with_process_id

</>

pub fn with_process_id(
  generator: Generator,
  process_id: Int,
) -> Generator

Sets the process ID for the generator.

with_worker_id

</>

pub fn with_worker_id(
  generator: Generator,
  worker_id: Int,
) -> Generator

Sets the worker ID for the generator.

worker_id

</>

pub fn worker_id(id: Int) -> Int

Extracts the worker ID from a Snowflake ID.