typedflake 0.2.0

Snowflake-style IDs as distinct, validated newtypes
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

//! Run with `cargo bench -p typedflake`, optionally with `--features serde`.

use std::hint::black_box;
use std::sync::Barrier;
use std::thread;
use std::time::Instant;

use criterion::{Criterion, criterion_group, criterion_main};
use typedflake::{Alphabet, Parts, TypedNode, typedflake};

/// Default layout: 4096 IDs per millisecond.
#[typedflake(epoch = "2025-01-01")]
#[cfg_attr(feature = "serde", derive(typedflake::Serde))]
pub struct DefaultId(i64);

/// Four million IDs per millisecond, so the hot path never runs out of
/// sequence numbers while it is being measured.
#[typedflake(epoch = "2025-01-01", bits(timestamp = 41, node = 0, sequence = 22))]
pub struct RoomyId(i64);

#[derive(Debug, Clone, Copy, TypedNode)]
pub struct AppNode {
    #[node(bits = 5)]
    pub worker: u8,
    #[node(bits = 5)]
    pub process: u8,
}

#[typedflake(epoch = "2025-01-01", node = AppNode)]
pub struct TypedId(i64);

#[typedflake(epoch = "2025-01-01", alphabet = Alphabet::BASE62)]
pub struct Base62Id(i64);

/// A power-of-two base, for comparison with base 62.
#[typedflake(epoch = "2025-01-01", alphabet = Alphabet::BASE64_URL)]
pub struct Base64Id(i64);

fn generation(c: &mut Criterion) {
    typedflake::init(0).unwrap();
    let mut group = c.benchmark_group("generate");

    group.bench_function("static", |b| b.iter(|| RoomyId::generate().unwrap()));

    let generator = RoomyId::generator(0).unwrap();
    group.bench_function("explicit", |b| b.iter(|| generator.generate().unwrap()));

    // Bound by the layout's 4096 IDs per millisecond, not by CPU time.
    group.bench_function("blocking_across_sequence_rollover", |b| {
        b.iter(|| DefaultId::generate_blocking().unwrap())
    });

    for threads in [2, 4, 8] {
        group.bench_function(format!("contended_{threads}_threads"), |b| {
            b.iter_custom(|iterations| {
                let per_thread = iterations / threads + 1;
                let barrier = Barrier::new(threads as usize + 1);
                thread::scope(|scope| {
                    for _ in 0..threads {
                        let generator = generator.clone();
                        let barrier = &barrier;
                        scope.spawn(move || {
                            barrier.wait();
                            for _ in 0..per_thread {
                                // Exhaustion is possible when every thread
                                // lands in one millisecond; it is still an
                                // answer from the generator.
                                let _ = black_box(generator.generate());
                            }
                        });
                    }
                    barrier.wait();
                    Instant::now()
                })
                .elapsed()
            });
        });
    }

    group.finish();
}

fn initialization(c: &mut Criterion) {
    let mut group = c.benchmark_group("generator");

    group.bench_function("lookup_existing_node", |b| {
        b.iter(|| DefaultId::generator(black_box(7)).unwrap())
    });
    group.bench_function("clone", |b| {
        let generator = DefaultId::generator(7).unwrap();
        b.iter(|| generator.clone())
    });

    group.finish();
}

fn values(c: &mut Criterion) {
    let mut group = c.benchmark_group("value");
    let id = DefaultId::try_from(232_900_560_974_681_078_i64).unwrap();
    let typed = TypedId::try_from(232_900_560_974_681_078_i64).unwrap();
    let text = id.to_string();

    group.bench_function("try_from_i64", |b| {
        b.iter(|| DefaultId::try_from(black_box(id.get())).unwrap())
    });
    group.bench_function("parts", |b| b.iter(|| black_box(id).parts()));
    group.bench_function("parts_typed_node", |b| b.iter(|| black_box(typed).parts()));
    group.bench_function("from_parts", |b| {
        let parts: Parts<u32> = id.parts();
        b.iter(|| DefaultId::from_parts(black_box(parts)).unwrap())
    });
    group.bench_function("from_parts_typed_node", |b| {
        let parts = typed.parts();
        b.iter(|| TypedId::from_parts(black_box(parts)).unwrap())
    });
    group.bench_function("to_string", |b| b.iter(|| black_box(id).to_string()));
    group.bench_function("parse", |b| {
        b.iter(|| black_box(text.as_str()).parse::<DefaultId>().unwrap())
    });

    let base62 = Base62Id::try_from(id.get()).unwrap();
    let base62_text = base62.encode();
    group.bench_function("encode_base62", |b| b.iter(|| black_box(base62).encode()));
    group.bench_function("decode_base62", |b| {
        b.iter(|| Base62Id::decode(black_box(base62_text.as_str())).unwrap())
    });
    let base64 = Base64Id::try_from(id.get()).unwrap();
    let base64_text = base64.encode();
    group.bench_function("encode_base64_url", |b| {
        b.iter(|| black_box(base64).encode())
    });
    group.bench_function("decode_base64_url", |b| {
        b.iter(|| Base64Id::decode(black_box(base64_text.as_str())).unwrap())
    });

    #[cfg(feature = "serde")]
    {
        let json = serde_json::to_string(&id).unwrap();
        group.bench_function("serde_json_serialize", |b| {
            b.iter(|| serde_json::to_string(&black_box(id)).unwrap())
        });
        group.bench_function("serde_json_deserialize", |b| {
            b.iter(|| serde_json::from_str::<DefaultId>(black_box(&json)).unwrap())
        });
    }

    group.finish();
}

criterion_group!(benches, generation, initialization, values);
criterion_main!(benches);