nexus-id 1.0.0

High-performance ID generators for low-latency systems
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
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
255
256
257
258
259
260
261
262
263
264
265

//! Serde implementations for all ID types.
//!
//! String types serialize as strings. Numeric types serialize as numbers.

use core::fmt;

use serde::de::{self, Visitor};
use serde::{Deserialize, Deserializer, Serialize, Serializer};

use crate::snowflake_id::{MixedId32, MixedId64, SnowflakeId32, SnowflakeId64};
use crate::typeid::TypeId;
use crate::types::{Base36Id, Base62Id, HexId64, Ulid, Uuid, UuidCompact};

// =============================================================================
// String types: serialize as strings
// =============================================================================

macro_rules! impl_serde_str {
    ($ty:ident, $name:expr, $len:expr) => {
        impl Serialize for $ty {
            #[inline]
            fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
                serializer.serialize_str(self.as_str())
            }
        }

        impl<'de> Deserialize<'de> for $ty {
            fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
                struct IdVisitor;

                impl<'de> Visitor<'de> for IdVisitor {
                    type Value = $ty;

                    fn expecting(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
                        write!(f, "a {}-character {} string", $len, $name)
                    }

                    fn visit_str<E: de::Error>(self, v: &str) -> Result<Self::Value, E> {
                        $ty::parse(v).map_err(de::Error::custom)
                    }
                }

                deserializer.deserialize_str(IdVisitor)
            }
        }
    };
}

impl_serde_str!(Uuid, "UUID", 36);
impl_serde_str!(UuidCompact, "compact UUID", 32);
impl_serde_str!(Ulid, "ULID", 26);
impl_serde_str!(HexId64, "hex ID", 16);
impl_serde_str!(Base62Id, "base62 ID", 11);
impl_serde_str!(Base36Id, "base36 ID", 13);

// =============================================================================
// TypeId: serialize as string
// =============================================================================

impl<const CAP: usize> Serialize for TypeId<CAP> {
    #[inline]
    fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
        serializer.serialize_str(self.as_str())
    }
}

impl<'de, const CAP: usize> Deserialize<'de> for TypeId<CAP> {
    fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
        struct TypeIdVisitor<const C: usize>;

        impl<const C: usize> Visitor<'_> for TypeIdVisitor<C> {
            type Value = TypeId<C>;

            fn expecting(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
                write!(f, "a TypeId string (prefix_suffix)")
            }

            fn visit_str<E: de::Error>(self, v: &str) -> Result<Self::Value, E> {
                TypeId::parse(v).map_err(de::Error::custom)
            }
        }

        deserializer.deserialize_str(TypeIdVisitor::<CAP>)
    }
}

// =============================================================================
// Numeric types: serialize as integers
// =============================================================================

impl<const TS: u8, const WK: u8, const SQ: u8> Serialize for SnowflakeId64<TS, WK, SQ> {
    #[inline]
    fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
        serializer.serialize_u64(self.raw())
    }
}

impl<'de, const TS: u8, const WK: u8, const SQ: u8> Deserialize<'de> for SnowflakeId64<TS, WK, SQ> {
    fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
        struct IdVisitor<const T: u8, const W: u8, const S: u8>;

        impl<const T: u8, const W: u8, const S: u8> Visitor<'_> for IdVisitor<T, W, S> {
            type Value = SnowflakeId64<T, W, S>;

            fn expecting(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
                f.write_str("a u64 snowflake ID")
            }

            fn visit_u64<E: de::Error>(self, v: u64) -> Result<Self::Value, E> {
                Ok(SnowflakeId64::from_raw(v))
            }
        }

        deserializer.deserialize_u64(IdVisitor::<TS, WK, SQ>)
    }
}

impl<const TS: u8, const WK: u8, const SQ: u8> Serialize for SnowflakeId32<TS, WK, SQ> {
    #[inline]
    fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
        serializer.serialize_u32(self.raw())
    }
}

impl<'de, const TS: u8, const WK: u8, const SQ: u8> Deserialize<'de> for SnowflakeId32<TS, WK, SQ> {
    fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
        struct IdVisitor<const T: u8, const W: u8, const S: u8>;

        impl<const T: u8, const W: u8, const S: u8> Visitor<'_> for IdVisitor<T, W, S> {
            type Value = SnowflakeId32<T, W, S>;

            fn expecting(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
                f.write_str("a u32 snowflake ID")
            }

            fn visit_u32<E: de::Error>(self, v: u32) -> Result<Self::Value, E> {
                Ok(SnowflakeId32::from_raw(v))
            }
        }

        deserializer.deserialize_u32(IdVisitor::<TS, WK, SQ>)
    }
}

impl<const TS: u8, const WK: u8, const SQ: u8> Serialize for MixedId64<TS, WK, SQ> {
    #[inline]
    fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
        serializer.serialize_u64(self.raw())
    }
}

impl<'de, const TS: u8, const WK: u8, const SQ: u8> Deserialize<'de> for MixedId64<TS, WK, SQ> {
    fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
        struct IdVisitor<const T: u8, const W: u8, const S: u8>;

        impl<const T: u8, const W: u8, const S: u8> Visitor<'_> for IdVisitor<T, W, S> {
            type Value = MixedId64<T, W, S>;

            fn expecting(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
                f.write_str("a u64 mixed ID")
            }

            fn visit_u64<E: de::Error>(self, v: u64) -> Result<Self::Value, E> {
                Ok(MixedId64::from_raw(v))
            }
        }

        deserializer.deserialize_u64(IdVisitor::<TS, WK, SQ>)
    }
}

impl<const TS: u8, const WK: u8, const SQ: u8> Serialize for MixedId32<TS, WK, SQ> {
    #[inline]
    fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
        serializer.serialize_u32(self.raw())
    }
}

impl<'de, const TS: u8, const WK: u8, const SQ: u8> Deserialize<'de> for MixedId32<TS, WK, SQ> {
    fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
        struct IdVisitor<const T: u8, const W: u8, const S: u8>;

        impl<const T: u8, const W: u8, const S: u8> Visitor<'_> for IdVisitor<T, W, S> {
            type Value = MixedId32<T, W, S>;

            fn expecting(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
                f.write_str("a u32 mixed ID")
            }

            fn visit_u32<E: de::Error>(self, v: u32) -> Result<Self::Value, E> {
                Ok(MixedId32::from_raw(v))
            }
        }

        deserializer.deserialize_u32(IdVisitor::<TS, WK, SQ>)
    }
}

// =============================================================================
// Tests
// =============================================================================

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn uuid_serde_roundtrip() {
        let uuid = Uuid::parse("01234567-89ab-cdef-fedc-ba9876543210").unwrap();
        let json = serde_json::to_string(&uuid).unwrap();
        assert_eq!(json, "\"01234567-89ab-cdef-fedc-ba9876543210\"");
        let restored: Uuid = serde_json::from_str(&json).unwrap();
        assert_eq!(uuid, restored);
    }

    #[test]
    fn uuid_compact_serde_roundtrip() {
        let uuid = UuidCompact::parse("0123456789abcdeffedcba9876543210").unwrap();
        let json = serde_json::to_string(&uuid).unwrap();
        let restored: UuidCompact = serde_json::from_str(&json).unwrap();
        assert_eq!(uuid, restored);
    }

    #[test]
    fn hex_id_serde_roundtrip() {
        let id = HexId64::encode(0xDEAD_BEEF_CAFE_BABE);
        let json = serde_json::to_string(&id).unwrap();
        assert_eq!(json, "\"deadbeefcafebabe\"");
        let restored: HexId64 = serde_json::from_str(&json).unwrap();
        assert_eq!(id, restored);
    }

    #[test]
    fn snowflake_id64_serde_roundtrip() {
        let id = SnowflakeId64::<42, 6, 16>::from_raw(123456789);
        let json = serde_json::to_string(&id).unwrap();
        assert_eq!(json, "123456789");
        let restored: SnowflakeId64<42, 6, 16> = serde_json::from_str(&json).unwrap();
        assert_eq!(id, restored);
    }

    #[test]
    fn mixed_id64_serde_roundtrip() {
        let id = MixedId64::<42, 6, 16>::from_raw(987654321);
        let json = serde_json::to_string(&id).unwrap();
        let restored: MixedId64<42, 6, 16> = serde_json::from_str(&json).unwrap();
        assert_eq!(id, restored);
    }

    #[test]
    fn base62_serde_roundtrip() {
        let id = Base62Id::encode(12345);
        let json = serde_json::to_string(&id).unwrap();
        let restored: Base62Id = serde_json::from_str(&json).unwrap();
        assert_eq!(id, restored);
    }

    #[test]
    fn base36_serde_roundtrip() {
        let id = Base36Id::encode(12345);
        let json = serde_json::to_string(&id).unwrap();
        let restored: Base36Id = serde_json::from_str(&json).unwrap();
        assert_eq!(id, restored);
    }
}