ferroid 2.0.0

High-performance ULID and Snowflake-style IDs. Unique, monotonic, and lexicographically sortable IDs optimized for low-latency services and async workloads.
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

use core::{
    fmt,
    hash::Hash,
    ops::{
        Add, AddAssign, BitAnd, BitAndAssign, BitOr, BitOrAssign, BitXor, BitXorAssign, Div,
        DivAssign, Mul, MulAssign, Not, Shl, ShlAssign, Shr, ShrAssign, Sub, SubAssign,
    },
};

use crate::id::ToU64;

/// A trait for types that wrap a primitive scalar identifier.
///
/// This is used to abstract over the raw scalar type behind an ID (e.g., `u64`,
/// `u128`).
///
/// Types implementing `Id` must define a scalar type `Ty` and provide
/// conversion to/from this raw representation.
pub trait Id: Copy + Clone + PartialOrd + Ord + PartialEq + Eq + Hash + fmt::Debug {
    /// Zero value (used for resetting the sequence)
    const ZERO: Self::Ty;

    /// One value (used for incrementing the sequence)
    const ONE: Self::Ty;

    /// Scalar type for all bit fields (typically `u64` or `u128`)
    type Ty: Copy
        + Clone
        + Default
        + fmt::Debug
        + fmt::Display
        + Ord
        + PartialOrd
        + Eq
        + PartialEq
        + Hash
        // For clock millis and testing
        + ToU64
        // For base32 decode and testing
        + From<u8>
        // Arithmetic
        + Add<Output = Self::Ty>
        + AddAssign<Self::Ty>
        + Sub<Output = Self::Ty>
        + SubAssign<Self::Ty>
        + Mul<Output = Self::Ty>
        + MulAssign<Self::Ty>
        + Div<Output = Self::Ty>
        + DivAssign<Self::Ty>
        // Bitwise
        + BitOr<Output = Self::Ty>
        + BitOrAssign<Self::Ty>
        + BitAnd<Output = Self::Ty>
        + BitAndAssign<Self::Ty>
        + BitXor<Output = Self::Ty>
        + BitXorAssign<Self::Ty>
        + Not<Output = Self::Ty>
        // Shifting
        + Shl<u8, Output = Self::Ty>
        + Shr<u8, Output = Self::Ty>
        + Shl<u32, Output = Self::Ty>
        + Shr<u32, Output = Self::Ty>
        + Shl<u64, Output = Self::Ty>
        + Shr<u64, Output = Self::Ty>
        + Shl<u128, Output = Self::Ty>
        + Shr<u128, Output = Self::Ty>
        + Shl<usize, Output = Self::Ty>
        + Shr<usize, Output = Self::Ty>
        + ShlAssign<Self::Ty>
        + ShrAssign<Self::Ty>;

    /// Converts this type into its raw type representation
    fn to_raw(&self) -> Self::Ty;

    /// Converts a raw type into this type
    fn from_raw(raw: Self::Ty) -> Self;
}