twitter_snowflake 1.0.3

A lightweight, efficient library that implements Twitter's Snowflake algorithm
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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116

use twitter_snowflake::{Snowflake, SnowflakeError};

#[test]
fn test_new() {
    let worker_id = 1;
    let snowflake = Snowflake::new(worker_id);
    assert!(snowflake.is_ok());
}

#[test]
fn test_invalid_worker_id() {
    let worker_id = 1024;
    let snowflake = Snowflake::new(worker_id);
    assert!(matches!(snowflake.err(), Some(SnowflakeError::ArgumentError(..))));
}

#[test]
fn test_generate() {
    let worker_id = 1;
    let mut snowflake = Snowflake::new(worker_id).unwrap();
    let sfid = snowflake.generate();
    assert!(sfid.is_ok());
}

#[test]
fn test_id_unique() {
    let worker_id = 1;
    let mut snowflake = Snowflake::new(worker_id).unwrap();
    let sfid1 = snowflake.generate().unwrap();
    let sfid2 = snowflake.generate().unwrap();
    assert_ne!(sfid1, sfid2);
}

#[test]
fn test_id_order() {
    let worker_id = 1;
    let mut snowflake = Snowflake::new(worker_id).unwrap();
    let sfid1 = snowflake.generate().unwrap();
    let sfid2 = snowflake.generate().unwrap();
    assert!(sfid1 < sfid2);
}

#[test]
fn test_invalid_worker_id_bits() {
    let worker_id = 1;
    let worker_id_bits = 100;
    let snowflake = Snowflake::builder()
        .with_worker_id(worker_id)
        .with_worker_id_bits(worker_id_bits)
        .build();
    assert!(matches!(snowflake.err(), Some(SnowflakeError::ArgumentError(..))));
}

#[test]
fn test_invalid_epoch() {
    let worker_id = 1;
    let epoch = 1_000_000_000_000_000;
    let snowflake = Snowflake::builder().with_worker_id(worker_id).with_epoch(epoch).build();
    assert!(matches!(snowflake.err(), Some(SnowflakeError::InvalidEpoch)));
}

#[cfg(feature = "float-safe")]
mod float_safe_tests {
    use twitter_snowflake::{Snowflake, SnowflakeError};

    /// In float-safe mode, the generated ID must fit within the exact
    /// integer range of an IEEE 754 double-precision float (53-bit mantissa).
    const MAX_SAFE_INTEGER: u64 = (1u64 << 53) - 1; // 2^53 - 1

    #[test]
    fn test_generate() {
        let mut snowflake = Snowflake::new(1).unwrap();
        let id = snowflake.generate().unwrap();
        assert!(id < MAX_SAFE_INTEGER, "ID {id} exceeds IEEE 754 safe integer range");
    }

    #[test]
    fn test_id_unique() {
        let mut snowflake = Snowflake::new(1).unwrap();
        let id1 = snowflake.generate().unwrap();
        let id2 = snowflake.generate().unwrap();
        assert_ne!(id1, id2);
    }

    #[test]
    fn test_id_order() {
        let mut snowflake = Snowflake::new(1).unwrap();
        let id1 = snowflake.generate().unwrap();
        let id2 = snowflake.generate().unwrap();
        assert!(id1 < id2);
    }

    #[test]
    fn test_many_ids_stay_in_safe_range() {
        let mut snowflake = Snowflake::new(1).unwrap();
        for _ in 0..1000 {
            let id = snowflake.generate().unwrap();
            assert!(id < MAX_SAFE_INTEGER, "ID {id} exceeds IEEE 754 safe integer range");
        }
    }

    #[test]
    fn test_invalid_worker_id() {
        // float-safe mode uses 4 worker-id bits → max worker ID = 15
        let snowflake = Snowflake::new(16);
        assert!(matches!(snowflake.err(), Some(SnowflakeError::ArgumentError(..))));
    }

    #[test]
    fn test_invalid_epoch() {
        // float-safe mode expects epoch in seconds — supply a far-future second value
        let epoch = 1_000_000_000_000;
        let snowflake = Snowflake::builder().with_worker_id(1).with_epoch(epoch).build();
        assert!(matches!(snowflake.err(), Some(SnowflakeError::InvalidEpoch)));
    }
}