tnid 0.2.0

A UUID compatible ID with static type checking
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

use crate::name_encoding;
use crate::name_encoding::NameStr;
use crate::utils;

/// The mask for the first 28 bits of the 43-bit timestamp.
pub const TIMESTAMP_FIRST_28_MASK: u64 = 0x0000_07ff_ffff_8000;
/// The mask for the middle 12 bits of the 43-bit timestamp.
pub const TIMESTAMP_SECOND_12_MASK: u64 = 0x0000_0000_0000_7ff8;
/// The mask for the last 3 bits of the 43-bit timestamp.
pub const TIMESTAMP_LAST_3_MASK: u64 = 0x0000_0000_0000_0007;

/// Distributes the 43-bit millisecond timestamp into its three specific scattered sections
/// within the 128-bit TNID structure.
pub fn millis_mask(millis_since_epoch: u64) -> u128 {
    let mut mask = 0u128;

    mask |= ((millis_since_epoch & TIMESTAMP_FIRST_28_MASK) as u128)
        << (TIMESTAMP_FIRST_28_MASK.leading_zeros() + 64 - 20);

    mask |= ((millis_since_epoch & TIMESTAMP_SECOND_12_MASK) as u128)
        << (TIMESTAMP_SECOND_12_MASK.leading_zeros() + 64 - 52);

    mask |= ((millis_since_epoch & TIMESTAMP_LAST_3_MASK) as u128)
        << (TIMESTAMP_LAST_3_MASK.leading_zeros() + 64 - 68);

    mask
}

/// Mask for the 57 random bits in a V0 TNID.
pub const RANDOM_MASK: u128 = 0x00000000_0000_0000_01ff_ffffffffffff;

/// Places the random bits into their specific scattered positions for a V0 TNID.
pub fn random_bits_mask(random: u64) -> u128 {
    let random = random as u128;

    random & RANDOM_MASK
}

/// Creates a 128-bit V0 ID from its component parts.
pub fn make_from_parts(name: NameStr, epoch_millis: u64, random: u64) -> u128 {
    let mut id = 0u128;

    id |= name_encoding::name_mask(name);

    id |= millis_mask(epoch_millis);

    id |= utils::uuid_and_variant_mask(0);

    id |= random_bits_mask(random);

    id
}

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

    #[test]
    fn name_map_size() {
        assert_eq!(
            name_encoding::CHAR_MAPPING.len(),
            (2u8.pow(name_encoding::CHAR_BIT_LENGTH as u32) - 1) as usize
        );
    }

    #[test]
    fn name_mask_correct_location() {
        let name = NameStr::new("zzzz").expect("valid name");
        let mask = name_encoding::name_mask(name);

        assert_eq!(mask.leading_zeros(), 0);
        assert_eq!(mask.leading_ones(), 20);

        assert_eq!(mask.trailing_zeros(), 108);
    }

    #[test]
    fn name_map_sorts() {
        let mut entries = name_encoding::CHAR_MAPPING.iter();
        let mut last = entries.next().expect("mapping is non-empty");

        for next in entries {
            assert!(last.0 < next.0);
            assert!(last.1 < next.1);

            last = next;
        }
    }

    #[test]
    fn millis_mask_correct_location() {
        let mask = millis_mask(u64::MAX);

        assert_eq!(mask.leading_zeros(), 20);
        assert_eq!(mask.count_ones(), 43);
        assert_eq!(mask.trailing_zeros(), 57);
    }

    #[test]
    fn random_bits_mask_correct_location() {
        let mask = random_bits_mask(u64::MAX);

        const FRONT_ZEROS: u32 = 71;
        const BACK_ONES: u32 = 57;

        assert_eq!(BACK_ONES + FRONT_ZEROS, 128);
        assert_eq!(mask.leading_zeros(), FRONT_ZEROS);
        assert_eq!(mask.count_ones(), BACK_ONES);
    }
}