data_bucket 0.6.0

DataBucket is container for WorkTable's data
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
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
use crate::link::{Link, LINK_LENGTH};
use ordered_float::OrderedFloat;
use psc_nanoid::packed::AlphabetPackExt;
use psc_nanoid::PackedNanoid;
use rkyv::util::AlignedVec;
use std::{mem, sync::Arc};
use uuid::Uuid;

pub const fn align(len: usize) -> usize {
    if len.is_multiple_of(4) {
        len
    } else {
        (len / 4 + 1) * 4
    }
}

pub const fn align8(len: usize) -> usize {
    if len.is_multiple_of(8) {
        len
    } else {
        (len / 8 + 1) * 8
    }
}

/// Rounds `len` up to a multiple of `alignment`.
pub const fn align_to(len: usize, alignment: usize) -> usize {
    if len.is_multiple_of(alignment) {
        len
    } else {
        (len / alignment + 1) * alignment
    }
}

/// The widest 8-or-more-byte alignment claimed by the two member types, if
/// any.
///
/// rkyv pads a compound value out to its widest member alignment (8 for
/// `u64`-likes, 16 for `u128`/`i128`), so compound size models must round
/// to the real member alignment. Rounding a 16-aligned member to only 8
/// under-counts every archived record by up to 8 bytes.
fn wide_member_align<T1, T2>() -> Option<usize>
where
    T1: SizeMeasurable,
    T2: SizeMeasurable,
{
    let mut wide = None;
    for member_align in [T1::align(), T2::align()].into_iter().flatten() {
        if member_align % 8 == 0 && Some(member_align) > wide {
            wide = Some(member_align);
        }
    }
    wide
}

pub fn align_vec<const ALIGNMENT: usize>(mut v: AlignedVec<ALIGNMENT>) -> AlignedVec<ALIGNMENT> {
    if v.len() != align(v.len()) {
        let count = align(v.len()) - v.len();
        for _ in 0..count {
            v.push(0)
        }
    }

    v
}

/// Marks an objects that can return theirs approximate size after archiving via
/// [`rkyv`].
pub trait SizeMeasurable {
    /// Returns approximate size of the object archiving via [`rkyv`].
    fn aligned_size(&self) -> usize;

    /// Returns the archived size of this type's default value.
    ///
    /// The default implementation constructs `Self::default()`. Types with an
    /// expensive default may override this method in their `SizeMeasurable`
    /// implementation and return the size directly.
    fn default_aligned_size() -> usize
    where
        Self: Default,
    {
        Self::default().aligned_size()
    }

    fn align() -> Option<usize> {
        None
    }
}

macro_rules! size_measurable_for_sized {
    ($($t:ident),+) => {
        $(
            impl SizeMeasurable for $t {
                fn aligned_size(&self) -> usize {
                    mem::size_of::<$t>()
                }
                fn align() -> Option<usize> {
                    Some(align(mem::size_of::<$t>()))
                }
            }
        )+
    };
}

size_measurable_for_sized! {u8, u16, u32, u64, u128, usize, i8, i16, i32, i64, i128, isize, f32, f64, bool}

macro_rules! size_measurable_for_primitive_arrays {
    ($($t:ident),+) => {
        $(
            impl<const N: usize> SizeMeasurable for [$t; N] {
                fn aligned_size(&self) -> usize {
                    mem::size_of::<[$t; N]>()
                }
            }
        )+
    };
}

// Deliberately retain the previous `align() == None` behavior of the existing
// `[u8; 20]` and `[u8; 32]` implementations. Changing that value can alter
// persisted tuple and page offsets.
size_measurable_for_primitive_arrays! {u8, u16, u32, u64, u128, usize, i8, i16, i32, i64, i128, isize, f32, f64, bool}

impl SizeMeasurable for Link {
    fn aligned_size(&self) -> usize {
        LINK_LENGTH
    }
}

impl SizeMeasurable for Uuid {
    fn aligned_size(&self) -> usize {
        16
    }
}

impl<const N: usize, const B: usize, A: AlphabetPackExt> SizeMeasurable for PackedNanoid<N, B, A> {
    fn aligned_size(&self) -> usize {
        B
    }
}

impl<T> SizeMeasurable for OrderedFloat<T>
where
    T: SizeMeasurable,
{
    fn aligned_size(&self) -> usize {
        self.0.aligned_size()
    }
}

impl<T1, T2> SizeMeasurable for (T1, T2)
where
    T1: SizeMeasurable,
    T2: SizeMeasurable,
{
    fn aligned_size(&self) -> usize {
        let len = self.0.aligned_size() + self.1.aligned_size();
        match wide_member_align::<T1, T2>() {
            Some(member_align) => align_to(len, member_align),
            None => align(len),
        }
    }

    fn align() -> Option<usize> {
        wide_member_align::<T1, T2>()
    }
}

// That was found on practice... Check unit test for proofs that works.
impl SizeMeasurable for String {
    fn aligned_size(&self) -> usize {
        if self.len() <= 8 {
            8
        } else {
            align(self.len() + 8)
        }
    }
}

impl<T> SizeMeasurable for Vec<T>
where
    T: Default + SizeMeasurable,
{
    fn aligned_size(&self) -> usize {
        let val_size = <T as SizeMeasurable>::default_aligned_size();
        let vec_content_size = if val_size == 2 {
            2
        } else if val_size == 4 {
            4
        } else if let Some(al) = T::align() {
            if al % 8 == 0 {
                align8(val_size)
            } else {
                val_size
            }
        } else {
            val_size
        };

        align(self.len() * vec_content_size) + 8
    }
}

impl<T: SizeMeasurable> SizeMeasurable for Arc<T> {
    fn aligned_size(&self) -> usize {
        self.as_ref().aligned_size()
    }
}

impl<T: SizeMeasurable> SizeMeasurable for Option<T>
where
    T: SizeMeasurable,
{
    fn align() -> Option<usize> {
        T::align()
    }

    fn aligned_size(&self) -> usize {
        size_of::<Option<T>>()
    }
}

impl<K, V> SizeMeasurable for indexset::core::pair::Pair<K, V>
where
    K: SizeMeasurable,
    V: SizeMeasurable,
{
    fn aligned_size(&self) -> usize {
        align(self.key.aligned_size() + self.value.aligned_size())
    }
}
impl<K, V> SizeMeasurable for indexset::core::multipair::MultiPair<K, V>
where
    K: SizeMeasurable,
    V: SizeMeasurable,
{
    fn aligned_size(&self) -> usize {
        align(self.key.aligned_size() + self.value.aligned_size())
    }
}

/// Marks an objects that can return theirs approximate size after archiving via
/// [`rkyv`].
pub trait VariableSizeMeasurable {
    /// Returns approximate size of the object archiving via [`rkyv`].
    fn aligned_size(length: usize) -> usize;
}

impl VariableSizeMeasurable for String {
    fn aligned_size(length: usize) -> usize {
        if length <= 8 {
            8
        } else {
            align(length + 8)
        }
    }
}

impl<K, L> VariableSizeMeasurable for indexset::core::pair::Pair<K, L>
where
    K: VariableSizeMeasurable,
    L: Default + SizeMeasurable,
{
    fn aligned_size(length: usize) -> usize {
        align(<L as SizeMeasurable>::default_aligned_size() + K::aligned_size(length))
    }
}
impl<K, L> VariableSizeMeasurable for indexset::core::multipair::MultiPair<K, L>
where
    K: VariableSizeMeasurable,
    L: Default + SizeMeasurable,
{
    fn aligned_size(length: usize) -> usize {
        align(<L as SizeMeasurable>::default_aligned_size() + K::aligned_size(length))
    }
}

#[cfg(test)]
mod test {
    use crate::util::sized::SizeMeasurable;
    use crate::{IndexValue, Link};
    use rkyv::to_bytes;
    use uuid::Uuid;

    #[test]
    fn primitive_arrays_preserve_existing_alignment_contract() {
        assert_eq!([0u8; 20].aligned_size(), 20);
        assert_eq!([0u8; 32].aligned_size(), 32);
        assert_eq!(<[u8; 20] as SizeMeasurable>::align(), None);
        assert_eq!(<[u8; 32] as SizeMeasurable>::align(), None);

        let values = [1u16, 2, 3];
        assert_eq!(
            values.aligned_size(),
            rkyv::to_bytes::<rkyv::rancor::Error>(&values)
                .unwrap()
                .len()
        );
    }

    #[test]
    fn default_size_helper_matches_previous_expression() {
        assert_eq!(
            <u64 as SizeMeasurable>::default_aligned_size(),
            u64::default().aligned_size()
        );
    }

    #[test]
    fn type_can_override_default_size_without_constructing_default() {
        struct ExpensiveDefault;

        impl Default for ExpensiveDefault {
            fn default() -> Self {
                panic!("the sizing override must not construct the default value")
            }
        }

        impl SizeMeasurable for ExpensiveDefault {
            fn aligned_size(&self) -> usize {
                64
            }

            fn default_aligned_size() -> usize {
                64
            }
        }

        assert_eq!(
            <ExpensiveDefault as SizeMeasurable>::default_aligned_size(),
            64
        );
    }

    #[test]
    fn test_uuid() {
        let u = Uuid::new_v4();
        assert_eq!(
            u.aligned_size(),
            rkyv::to_bytes::<rkyv::rancor::Error>(&u).unwrap().len()
        );
        let t = (Uuid::new_v4(), Link::default());
        assert_eq!(
            t.aligned_size(),
            rkyv::to_bytes::<rkyv::rancor::Error>(&t).unwrap().len()
        );
        let v = IndexValue {
            key: u,
            link: Default::default(),
        };
        assert_eq!(
            v.aligned_size(),
            rkyv::to_bytes::<rkyv::rancor::Error>(&v).unwrap().len()
        );
        let mut vec = Vec::new();
        vec.push(IndexValue {
            key: Uuid::new_v4(),
            link: Default::default(),
        });
        assert_eq!(
            vec.aligned_size(),
            rkyv::to_bytes::<rkyv::rancor::Error>(&vec).unwrap().len()
        );
        for _ in 0..600 {
            vec.push(IndexValue {
                key: Uuid::new_v4(),
                link: Default::default(),
            })
        }
        assert_eq!(
            vec.aligned_size(),
            rkyv::to_bytes::<rkyv::rancor::Error>(&vec).unwrap().len()
        )
    }

    #[test]
    fn test_16_aligned_members_measure_like_rkyv() {
        // rkyv pads compounds out to 16 for u128/i128 members; the model
        // used to round to 8 and under-count every archived record.
        let t = (u128::MAX, Link::default());
        assert_eq!(
            t.aligned_size(),
            to_bytes::<rkyv::rancor::Error>(&t).unwrap().len()
        );
        let t = (u128::MAX, u64::MAX);
        assert_eq!(
            t.aligned_size(),
            to_bytes::<rkyv::rancor::Error>(&t).unwrap().len()
        );
        let t = (i128::MAX, Link::default());
        assert_eq!(
            t.aligned_size(),
            to_bytes::<rkyv::rancor::Error>(&t).unwrap().len()
        );
        assert_eq!(<(u128, Link) as SizeMeasurable>::align(), Some(16));
        assert_eq!(<(u128, u64) as SizeMeasurable>::align(), Some(16));
        assert_eq!(<(u64, Link) as SizeMeasurable>::align(), Some(8));

        let v = IndexValue {
            key: u128::MAX,
            link: Link::default(),
        };
        assert_eq!(
            v.aligned_size(),
            to_bytes::<rkyv::rancor::Error>(&v).unwrap().len()
        );
        let v = IndexValue {
            key: (u128::MAX, u64::MAX),
            link: Link::default(),
        };
        assert_eq!(
            v.aligned_size(),
            to_bytes::<rkyv::rancor::Error>(&v).unwrap().len()
        );

        // The archived element stride of a vec must match too, so per-record
        // accounting stays exact for pages of such records.
        let vec = vec![(u128::MAX, Link::default()); 100];
        let one = (u128::MAX, Link::default()).aligned_size();
        let bytes = to_bytes::<rkyv::rancor::Error>(&vec).unwrap().len();
        let bytes_two_hundred =
            to_bytes::<rkyv::rancor::Error>(&vec![(u128::MAX, Link::default()); 200])
                .unwrap()
                .len();
        assert_eq!(bytes_two_hundred - bytes, 100 * one);
    }

    #[test]
    fn test_tuple() {
        let t = (u64::MAX, Link::default());
        assert_eq!(
            t.aligned_size(),
            to_bytes::<rkyv::rancor::Error>(&t).unwrap().len()
        );
        let t = (u32::MAX, Link::default());
        assert_eq!(
            t.aligned_size(),
            to_bytes::<rkyv::rancor::Error>(&t).unwrap().len()
        );
        let t = (u8::MAX, Link::default());
        assert_eq!(
            t.aligned_size(),
            to_bytes::<rkyv::rancor::Error>(&t).unwrap().len()
        );
        let t = (Some(0.0f64), Link::default());
        assert_eq!(
            t.aligned_size(),
            to_bytes::<rkyv::rancor::Error>(&t).unwrap().len()
        )
    }
    #[test]
    fn test_option() {
        let t = Some(0.0f64);
        assert_eq!(
            t.aligned_size(),
            to_bytes::<rkyv::rancor::Error>(&t).unwrap().len()
        );
    }

    #[test]
    fn test_string() {
        // Test if approximate size is correct for strings
        for i in 0..10_000 {
            let s = String::from_utf8(vec![b'a'; i]).unwrap();
            assert_eq!(
                s.aligned_size(),
                rkyv::to_bytes::<rkyv::rancor::Error>(&s).unwrap().len()
            )
        }
    }

    #[test]
    fn test_index_value_str() {
        // Test if approximate size is correct for strings
        for i in 0..10_000 {
            let s = String::from_utf8(vec![b'a'; i]).unwrap();
            let v = IndexValue {
                key: s,
                link: Default::default(),
            };
            assert_eq!(
                v.aligned_size(),
                rkyv::to_bytes::<rkyv::rancor::Error>(&v).unwrap().len()
            )
        }
    }

    #[test]
    fn test_packed_nanoid() {
        use psc_nanoid::{alphabet::Base64UrlAlphabet, packed::PackedNanoid, Nanoid};

        fn check<const N: usize, const B: usize>() {
            let id = Nanoid::<N, Base64UrlAlphabet>::new();
            let packed = PackedNanoid::<N, B, Base64UrlAlphabet>::pack(&id).unwrap();
            assert_eq!(
                packed.aligned_size(),
                rkyv::to_bytes::<rkyv::rancor::Error>(&packed)
                    .unwrap()
                    .len()
            );
        }

        // For Base64UrlAlphabet, PACK_BITS = 6, so B = ceil(N * 6 / 8)
        check::<1, 1>();
        check::<6, 5>();
        check::<10, 8>();
        check::<21, 16>();
        check::<32, 24>();
        check::<42, 32>();
        check::<64, 48>();
    }
}