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
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59

use std::time::SystemTime;
use crate::layout::BitLayout;

pub mod components;
pub mod creation;
pub mod generation;
pub mod decomposition;

#[cfg(test)]
pub mod tests;

pub use components::SnowflakeComponents;

/// A Snowflake ID generator with a configurable [`BitLayout`].
///
/// # Thread safety
///
/// `SnowflakeIdGenerator` is **not** `Send + Sync` by itself because its
/// internal state is mutated on every call. Wrap it in a `Mutex` / `RwLock`
/// when sharing across threads.
///
/// # Example — default layout
///
/// ```rust
/// use snowflake_gen::SnowflakeIdGenerator;
///
/// let mut idgen = SnowflakeIdGenerator::new(1, 1).unwrap();
/// let id = idgen.generate().unwrap();
/// assert!(id > 0);
/// ```
#[derive(Copy, Clone, Debug)]
pub struct SnowflakeIdGenerator {
    /// Epoch used for timestamp calculations.
    pub(crate) epoch: SystemTime,
    /// Timestamp of the last generated ID (millis since epoch).
    pub(crate) last_time_millis: i64,
    /// The machine identifier baked into every ID.
    pub machine_id: i32,
    /// The node (worker) identifier baked into every ID.
    pub node_id: i32,
    /// Per-millisecond auto-increment counter.
    pub(crate) idx: u16,
    /// Bit layout governing field widths and shifts.
    pub(crate) layout: BitLayout,
}

impl SnowflakeIdGenerator {
    /// Returns a reference to the [`BitLayout`] in use.
    #[inline]
    pub fn layout(&self) -> &BitLayout {
        &self.layout
    }

    /// Returns the epoch this generator was constructed with.
    #[inline]
    pub fn epoch(&self) -> SystemTime {
        self.epoch
    }
}