snowflake-gen 0.1.0

A configurable Snowflake ID generator with custom bit layouts, thread-local global generation, and ID decomposition
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

use thiserror::Error;

/// All errors that the snowflake crate can produce.
#[derive(Debug, Error, Clone, PartialEq, Eq)]
pub enum SnowflakeError {
    /// The bit widths of all four fields do not sum to 63.
    ///
    /// An `i64` has one sign bit, so the remaining 63 bits must be fully
    /// allocated to avoid negative IDs or wasted space.
    #[error(
        "bit fields must sum to exactly 63, \
         got timestamp({t}) + machine_id({m}) + node_id({n}) + sequence({s}) = {total}"
    )]
    InvalidBitLayout {
        t: u8,
        m: u8,
        n: u8,
        s: u8,
        total: u8,
    },

    /// A `machine_id` was provided that exceeds the layout's maximum.
    #[error("machine_id {given} exceeds maximum {max} for the configured bit width")]
    MachineIdOutOfRange { given: i32, max: i32 },

    /// A `node_id` was provided that exceeds the layout's maximum.
    #[error("node_id {given} exceeds maximum {max} for the configured bit width")]
    NodeIdOutOfRange { given: i32, max: i32 },

    /// The system clock moved backwards, which would break ID monotonicity.
    #[error("system clock moved backwards; cannot guarantee monotonic IDs")]
    ClockMovedBackwards,

    /// The system clock is not available (e.g. time before epoch).
    #[error("system clock error: time is before the configured epoch")]
    ClockBeforeEpoch,
}