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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
use std::time::Duration;
use std::hash::Hasher;
use crate::error;
#[derive(Eq, Clone)]
pub struct Snowflake<const TS: u8, const PID: u8, const SEQ: u8> {
pub(crate) ts: Duration,
pub(crate) tsm: i64,
pub(crate) pid: i64,
pub(crate) seq: i64,
}
impl<const TS: u8, const PID: u8, const SEQ: u8> Snowflake<TS, PID, SEQ> {
pub const MAX_TIMESTAMP: i64 = (1 << TS as i64) - 1;
pub const MAX_PRIMARY_ID: i64 = (1 << PID as i64) - 1;
pub const MAX_SEQUENCE: i64 = (1 << SEQ as i64) - 1;
pub const TIMESTAMP_SHIFT: i64 = (PID as i64 + SEQ as i64);
pub const PRIMARY_ID_SHIFT: i64 = SEQ as i64;
pub const TIMESTAMP_MASK: i64 = Self::MAX_TIMESTAMP << Self::TIMESTAMP_SHIFT;
pub const PRIMARY_ID_MASK: i64 = Self::MAX_PRIMARY_ID << Self::PRIMARY_ID_SHIFT;
pub const SEQUENCE_MASK: i64 = Self::MAX_SEQUENCE;
pub fn duration(&self) -> &Duration {
&self.ts
}
pub fn timestamp(&self) -> &i64 {
&self.tsm
}
pub fn primary_id(&self) -> &i64 {
&self.pid
}
pub fn sequence(&self) -> &i64 {
&self.seq
}
pub fn from_parts(tsm: i64, pid: i64, seq: i64) -> error::Result<Self> {
if tsm < 0 || tsm > Self::MAX_TIMESTAMP {
return Err(error::Error::EpochInvalid);
}
if pid < 0 || pid > Self::MAX_PRIMARY_ID {
return Err(error::Error::PrimaryIdInvalid);
}
if seq < 0 || seq > Self::MAX_SEQUENCE {
return Err(error::Error::SequenceInvalid);
}
let ts = Duration::from_millis(tsm as u64);
Ok(Snowflake { ts, tsm, pid, seq })
}
pub fn into_parts(self) -> (i64, i64, i64) {
(self.tsm, self.pid, self.seq)
}
pub fn id(&self) -> i64 {
(self.tsm << Self::TIMESTAMP_SHIFT) | (self.pid << Self::PRIMARY_ID_SHIFT) | self.seq
}
}
impl<const TS: u8, const PID: u8, const SEQ: u8> std::cmp::PartialEq for Snowflake<TS, PID, SEQ> {
fn eq(&self, rhs: &Self) -> bool {
self.tsm == rhs.tsm && self.pid == rhs.pid && self.seq == rhs.seq
}
}
impl<const TS: u8, const PID: u8, const SEQ: u8> std::hash::Hash for Snowflake<TS, PID, SEQ> {
fn hash<H: Hasher>(&self, state: &mut H) {
self.tsm.hash(state);
self.pid.hash(state);
self.seq.hash(state);
}
}
impl<const TS: u8, const PID: u8, const SEQ: u8> std::fmt::Debug for Snowflake<TS, PID, SEQ> {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let id = self.id();
f.debug_struct("Snowflake")
.field("id", &id)
.field("ts", &self.ts)
.field("tsm", &self.tsm)
.field("pid", &self.pid)
.field("seq", &self.seq)
.finish()
}
}
impl<const TS: u8, const PID: u8, const SEQ: u8> From<Snowflake<TS, PID, SEQ>> for i64 {
fn from(flake: Snowflake<TS, PID, SEQ>) -> i64 {
flake.id()
}
}
impl<const TS: u8, const PID: u8, const SEQ: u8> From<&Snowflake<TS, PID, SEQ>> for i64 {
fn from(flake: &Snowflake<TS, PID, SEQ>) -> i64 {
flake.id()
}
}
impl<const TS: u8, const PID: u8, const SEQ: u8> TryFrom<i64> for Snowflake<TS, PID, SEQ> {
type Error = error::Error;
fn try_from(id: i64) -> error::Result<Self> {
if id < 0 {
return Err(error::Error::InvalidId);
}
let millis = ((id & Self::TIMESTAMP_MASK) >> Self::TIMESTAMP_SHIFT) as u64;
Ok(Snowflake {
ts: Duration::from_millis(millis),
tsm: (id & Self::TIMESTAMP_MASK) >> Self::TIMESTAMP_SHIFT,
pid: (id & Self::PRIMARY_ID_MASK) >> Self::PRIMARY_ID_SHIFT,
seq: id & Self::SEQUENCE_MASK
})
}
}
impl<const TS: u8, const PID: u8, const SEQ: u8> TryFrom<&i64> for Snowflake<TS, PID, SEQ> {
type Error = error::Error;
fn try_from(id: &i64) -> error::Result<Self> {
if *id < 0 {
return Err(error::Error::InvalidId);
}
let millis = ((*id & Self::TIMESTAMP_MASK) >> Self::TIMESTAMP_SHIFT) as u64;
Ok(Snowflake {
ts: Duration::from_millis(millis),
tsm: (id & Self::TIMESTAMP_MASK) >> Self::TIMESTAMP_SHIFT,
pid: (id & Self::PRIMARY_ID_MASK) >> Self::PRIMARY_ID_SHIFT,
seq: id & Self::SEQUENCE_MASK,
})
}
}
#[cfg(test)]
mod test {
use super::*;
type TestSnowflake = Snowflake<43, 8, 12>;
#[test]
fn properly_calculated_consts() {
let max_timestamp: i64 = 0b1111111111111111111111111111111111111111111;
let max_primary_id: i64 = 0b11111111;
let max_sequence: i64 = 0b111111111111;
let timestamp_shift: i64 = 8 + 12;
let primary_id_shift: i64 = 12;
let timestamp_mask: i64 = 0b0_1111111111111111111111111111111111111111111_00000000_000000000000;
let primary_id_mask: i64 = 0b0_0000000000000000000000000000000000000000000_11111111_000000000000;
let sequence_mask: i64 = 0b0_0000000000000000000000000000000000000000000_00000000_111111111111;
assert_eq!(TestSnowflake::MAX_TIMESTAMP, max_timestamp, "invalid max timestamp");
assert_eq!(TestSnowflake::MAX_PRIMARY_ID, max_primary_id, "invalid max primary id");
assert_eq!(TestSnowflake::MAX_SEQUENCE, max_sequence, "invalid max sequence");
assert_eq!(TestSnowflake::TIMESTAMP_SHIFT, timestamp_shift, "invalid timestamp shift");
assert_eq!(TestSnowflake::PRIMARY_ID_SHIFT, primary_id_shift, "invalid primary id shift");
assert_eq!(TestSnowflake::TIMESTAMP_MASK, timestamp_mask, "invalid timestamp mask");
assert_eq!(TestSnowflake::PRIMARY_ID_MASK, primary_id_mask, "invalid primary id mask");
assert_eq!(TestSnowflake::SEQUENCE_MASK, sequence_mask, "invalid sequence mask");
}
#[test]
fn to_int_and_back() {
let flake = TestSnowflake::from_parts(1, 1, 1).unwrap();
let to_int: i64 = (&flake).into();
let to_flake: TestSnowflake = (&to_int).try_into().unwrap();
assert_eq!(to_flake, flake);
}
#[test]
fn properly_shifted_integers() {
let flake = TestSnowflake::from_parts(1, 1, 1).unwrap();
let expected: i64 = 0b00000000000000000000000000000000000000000001_00000001_000000000001;
assert_eq!(
flake.id(),
expected,
"impropperly formatted snowflake.\n{:064b}\n{:064b}\n{:#?}",
expected,
flake.id(),
flake
);
}
}