beakid 0.2.1

Snowflake-like 64-bit unique ID generator with PostgreSQL BIGINT-friendly i64 IDs.
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
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59

//! Error types returned by BeakId.

use std::error::Error;
use std::fmt;

/// Crate-local result type.
pub type Result<T> = std::result::Result<T, BeakIdError>;

/// Errors returned by BeakId configuration and generation.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum BeakIdError {
    /// `BEAKID_EPOCH` was not present.
    MissingEpoch,
    /// `BEAKID_EPOCH` was not a valid RFC 3339 UTC timestamp.
    InvalidEpoch(String),
    /// `BEAKID_WORKER_ID` was not a valid unsigned integer.
    InvalidWorkerId(String),
    /// `BEAKID_WORKER_ID` exceeded the 10-bit worker-id range.
    WorkerIdOutOfRange(u16),
    /// The system clock is before the configured epoch.
    ClockBeforeEpoch,
    /// The timestamp exceeded the 35-bit BeakId timestamp range.
    TimestampOverflow(u64),
    /// All virtual time windows are exhausted and real time has not caught up.
    Blocked,
    /// The standard background thread could not be spawned.
    BackgroundSpawnFailed(String),
}

impl fmt::Display for BeakIdError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::MissingEpoch => f.write_str("BEAKID_EPOCH is required"),
            Self::InvalidEpoch(value) => write!(
                f,
                "BEAKID_EPOCH must be an RFC 3339 UTC datetime, got {value:?}"
            ),
            Self::InvalidWorkerId(value) => {
                write!(
                    f,
                    "BEAKID_WORKER_ID must be an unsigned 16-bit integer, got {value:?}"
                )
            }
            Self::WorkerIdOutOfRange(value) => {
                write!(f, "BEAKID_WORKER_ID must fit in 10 bits, got {value}")
            }
            Self::ClockBeforeEpoch => f.write_str("system clock is before BEAKID_EPOCH"),
            Self::TimestampOverflow(value) => {
                write!(f, "timestamp window {value} exceeds the 35-bit range")
            }
            Self::Blocked => f.write_str("generator is blocked: virtual windows exhausted"),
            Self::BackgroundSpawnFailed(value) => {
                write!(f, "failed to spawn BeakId background thread: {value}")
            }
        }
    }
}

impl Error for BeakIdError {}