opendiskmap 0.1.0

Single-threaded disk-backed hash map with memory-mapped file backing
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
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
use std::mem::size_of;
use std::ops::Index;

use crate::byte_store::ByteStore;

/// This module contains the implementation of `Buffers`, a data structure
/// that stores a sequence of byte arrays in a single underlying `ByteStore`.
///
/// It's designed to be efficient for storing and retrieving variable-length
/// data, using a system of offsets to locate each item.
///
/// The layout of the `ByteStore` is as follows:
/// - A sequence of `usize` offsets, one for each stored item. Each offset
///   represents the cumulative length of all items up to that point.
/// - The actual data of the items, stored in reverse order from the end of
///   the `ByteStore`.
///
/// This design allows for efficient appends, as new data is added to the end
/// of the data section (which grows towards the start of the buffer), and a
/// new offset is added to the end of the offset section.
///
/// When the buffer runs out of space, it grows, and the data section is
/// shifted to the new end of the buffer to make space for new offsets and data.
/// `Buffers` stores a sequence of byte arrays in a single `ByteStore`.
#[derive(Debug)]
pub struct Buffers<T: ByteStore> {
    byte_store: T,
    // The number of items in the store
    count: usize,
    // The start of the data section, from the end of the store
    data_end: usize,
}

/// A slice of `Buffers`, representing a sub-sequence of the stored items.
#[derive(Debug)]
pub struct BuffersSlice<'a, T: ByteStore> {
    buffers: &'a Buffers<T>,
    start: usize, // Start index of the slice
    end: usize,   // End index of the slice
}

impl<'a, T: ByteStore> Clone for BuffersSlice<'a, T> {
    fn clone(&self) -> Self {
        *self
    }
}

impl<'a, T: ByteStore> Copy for BuffersSlice<'a, T> {}

impl<'a, T: ByteStore> BuffersSlice<'a, T> {
    /// Create a new slice from this slice
    pub fn slice(&self, start: usize, end: usize) -> Self {
        assert!(start <= end, "start must be <= end");
        assert!(end <= self.len(), "end out of bounds");
        BuffersSlice {
            buffers: self.buffers,
            start: self.start + start,
            end: self.start + end,
        }
    }

    /// Return the number of entries in the slice
    pub fn len(&self) -> usize {
        self.end - self.start
    }

    /// Return an iterator over the entries in the slice
    pub fn iter(&self) -> BuffersSliceIter<'a, T> {
        BuffersSliceIter {
            slice: *self,
            pos: 0,
        }
    }

    /// Retrieve the byte slice at a given index
    pub fn get(&self, index: usize) -> Option<&'a [u8]> {
        if index >= self.len() {
            return None;
        }
        self.buffers.get(self.start + index)
    }
}

pub struct BuffersSliceIter<'a, T: ByteStore> {
    slice: BuffersSlice<'a, T>,
    pos: usize,
}

impl<'a, T: ByteStore> Iterator for BuffersSliceIter<'a, T> {
    type Item = &'a [u8];

    fn next(&mut self) -> Option<Self::Item> {
        if self.pos < self.slice.len() {
            let item = self.slice.get(self.pos);
            self.pos += 1;
            item
        } else {
            None
        }
    }
}

impl<'a, B: ByteStore> IntoIterator for BuffersSlice<'a, B> {
    type Item = &'a [u8];
    type IntoIter = BuffersSliceIter<'a, B>;

    fn into_iter(self) -> Self::IntoIter {
        self.iter()
    }
}

impl<T: ByteStore> Buffers<T> {
    fn bs(&self) -> &[u8] {
        self.byte_store.as_ref()
    }

    fn bs_mut(&mut self) -> &mut [u8] {
        self.byte_store.as_mut()
    }

    /// Create a new ByteStore with the given buffer
    pub fn new(byte_store: T) -> Self {
        let data_end = byte_store.as_ref().len();
        let mut s = Self {
            byte_store,
            count: 0,
            data_end,
        };
        s.write_header_and_initial_offset();
        s
    }

    fn get_count(byte_store: &T) -> usize {
        let count_bytes_range = 0..size_of::<usize>();
        let count_bytes: [u8; size_of::<usize>()] =
            byte_store.as_ref()[count_bytes_range].try_into().unwrap();
        usize::from_le_bytes(count_bytes)
    }

    fn set_count(&mut self) {
        let count_bytes_range = 0..size_of::<usize>();
        let count = self.count;
        self.bs_mut()[count_bytes_range].copy_from_slice(&count.to_le_bytes());
    }

    pub fn load(byte_store: T) -> Self {
        let count = Self::get_count(&byte_store);

        let mut s = Self {
            byte_store,
            count,
            data_end: 0, // temporary
        };

        let last_offset = s.offsets().last().copied().unwrap_or(0);
        s.data_end = s.bs().len() - last_offset;
        s
    }

    fn write_header_and_initial_offset(&mut self) {
        let needed = self.offsets_end();
        if needed > self.bs().len() {
            let grow_by = needed - self.bs().len();
            self.byte_store.grow(grow_by);
            self.data_end = self.bs().len();
        }
        self.set_count();
        let initial_offset_start = Self::header_size();
        let initial_offset_end = initial_offset_start + size_of::<usize>();
        let initial_offset_slice = &mut self.bs_mut()[initial_offset_start..initial_offset_end];
        initial_offset_slice.copy_from_slice(&0usize.to_le_bytes());
    }

    const fn header_size() -> usize {
        size_of::<usize>()
    }

    pub fn store(&self) -> &T {
        &self.byte_store
    }

    pub fn offsets(&self) -> &[usize] {
        let offsets_start = Self::header_size();
        let offsets_end = self.offsets_end();
        let offset_bytes = &self.bs()[offsets_start..offsets_end];
        bytemuck::cast_slice(offset_bytes)
    }

    fn offsets_mut(&mut self) -> &mut [usize] {
        let offsets_start = Self::header_size();
        let offsets_end = self.offsets_end();
        let offset_bytes = &mut self.bs_mut()[offsets_start..offsets_end];
        bytemuck::cast_slice_mut(offset_bytes)
    }

    /// Create a slice of the buffers from [start, end)
    pub fn slice(&self, start: usize, end: usize) -> BuffersSlice<'_, T> {
        assert!(start <= end, "start must be <= end");
        assert!(end <= self.len(), "end out of bounds");
        BuffersSlice {
            buffers: self,
            start,
            end,
        }
    }

    /// Return an iterator over all entries (by reference)
    pub fn iter(&self) -> BuffersSliceIter<'_, T> {
        self.slice(0, self.len()).iter()
    }

    /// Append a byte slice to the store, returning the index of the stored data
    pub fn append(&mut self, bytes: impl AsRef<[u8]>) -> usize {
        let bytes = bytes.as_ref();
        let offset_size = size_of::<usize>();

        // Calculate total space needed: length prefix (8 bytes) + data + padding to 8-byte boundary
        let actual_len = bytes.len();
        let len_prefix_size = size_of::<u64>();
        let data_with_prefix_len = len_prefix_size + actual_len;
        let padded_len = (data_with_prefix_len + 7) & !7; // Round up to next multiple of 8
        let total_data_size = padded_len;

        let needed_space = offset_size + total_data_size;

        if self.free_space() < needed_space {
            let old_len = self.bs().len();
            let data_len = old_len - self.data_end;

            let mut new_len = if old_len == 0 { 256 } else { old_len * 2 };

            let required_len = self.offsets_end() + data_len + needed_space;
            while new_len < required_len {
                new_len *= 2;
            }

            let growth = new_len - old_len;
            self.byte_store.grow(growth);
            let new_actual_len = self.bs().len();

            let new_data_end = new_actual_len - data_len;

            if data_len > 0 {
                let data_src_range = self.data_end..old_len;
                self.bs_mut().copy_within(data_src_range, new_data_end);
            }

            self.data_end = new_data_end;
        }

        // Write the data: length prefix + actual data + padding
        self.data_end -= total_data_size;
        let data_write_start = self.data_end;

        // Write length prefix as u64
        let len_bytes = (actual_len as u64).to_le_bytes();
        self.bs_mut()[data_write_start..data_write_start + len_prefix_size]
            .copy_from_slice(&len_bytes);

        // Write actual data
        let data_start = data_write_start + len_prefix_size;
        self.bs_mut()[data_start..data_start + actual_len].copy_from_slice(bytes);

        // Zero out padding bytes
        let padding_start = data_start + actual_len;
        let padding_end = data_write_start + total_data_size;
        if padding_end > padding_start {
            self.bs_mut()[padding_start..padding_end].fill(0);
        }

        let cumulative_len = self.bs().len() - self.data_end;

        let index = self.count;
        self.count += 1;

        // Update count in header
        self.set_count();

        // Write new cumulative offset
        let count = self.count;
        self.offsets_mut()[count] = cumulative_len;

        index
    }

    fn offsets_end(&self) -> usize {
        Self::header_size() + (self.count + 1) * size_of::<usize>()
    }

    /// Get the number of stored entries
    pub fn len(&self) -> usize {
        self.count
    }

    /// Check if the store is empty
    pub fn is_empty(&self) -> bool {
        self.count == 0
    }

    /// Get a byte slice by its index
    pub fn get(&self, index: usize) -> Option<&[u8]> {
        if index >= self.count {
            return None;
        }

        let offsets = self.offsets();
        let start_cumulative = offsets[index];
        let end_cumulative = offsets[index + 1];

        if end_cumulative < start_cumulative {
            panic!(
                "Invalid offsets: end_cumulative ({end_cumulative}) < start_cumulative ({start_cumulative}) for index {index}"
            );
        }

        let total_len = self.bs().len();
        let entry_start = total_len - end_cumulative;
        let entry_end = total_len - start_cumulative;

        let entry_data = &self.bs()[entry_start..entry_end];

        // Read the length prefix (first 8 bytes as u64)
        if entry_data.len() < size_of::<u64>() {
            panic!("Entry data too small to contain length prefix for index {index}");
        }

        let len_prefix_size = size_of::<u64>();
        let len_bytes: [u8; 8] = entry_data[0..len_prefix_size].try_into().unwrap();
        let actual_len = u64::from_le_bytes(len_bytes) as usize;

        // Return only the actual data (skip the length prefix)
        let data_start = len_prefix_size;
        let data_end = data_start + actual_len;

        if data_end > entry_data.len() {
            panic!(
                "Actual length {actual_len} exceeds entry size {} for index {index}",
                entry_data.len() - len_prefix_size
            );
        }

        Some(&entry_data[data_start..data_end])
    }

    /// Get the raw aligned data by its index (includes length prefix and padding)
    /// This is useful for zero-copy deserialization where alignment matters
    pub fn get_aligned_raw(&self, index: usize) -> Option<&[u8]> {
        if index >= self.count {
            return None;
        }

        let offsets = self.offsets();
        let start_cumulative = offsets[index];
        let end_cumulative = offsets[index + 1];

        if end_cumulative < start_cumulative {
            panic!(
                "Invalid offsets: end_cumulative ({end_cumulative}) < start_cumulative ({start_cumulative}) for index {index}"
            );
        }

        let total_len = self.bs().len();
        let entry_start = total_len - end_cumulative;
        let entry_end = total_len - start_cumulative;

        Some(&self.bs()[entry_start..entry_end])
    }

    /// Get the data portion (without length prefix) starting at the aligned offset
    /// This returns the data + padding, which maintains 8-byte alignment for zero-copy
    pub fn get_aligned_data(&self, index: usize) -> Option<&[u8]> {
        if index >= self.count {
            return None;
        }

        let offsets = self.offsets();
        let start_cumulative = offsets[index];
        let end_cumulative = offsets[index + 1];

        if end_cumulative < start_cumulative {
            panic!(
                "Invalid offsets: end_cumulative ({end_cumulative}) < start_cumulative ({start_cumulative}) for index {index}"
            );
        }

        let total_len = self.bs().len();
        let entry_start = total_len - end_cumulative;
        let entry_end = total_len - start_cumulative;

        let entry_data = &self.bs()[entry_start..entry_end];

        // Skip the length prefix and return the aligned data portion
        let len_prefix_size = size_of::<u64>();
        if entry_data.len() < len_prefix_size {
            panic!("Entry data too small to contain length prefix for index {index}");
        }

        Some(&entry_data[len_prefix_size..])
    }

    /// Calculate the free space in the buffer. This is the space between the end of
    /// the offsets and the start of the data.
    pub fn free_space(&self) -> usize {
        if self.data_end < self.offsets_end() {
            0
        } else {
            self.data_end - self.offsets_end()
        }
    }

    /// Clear all entries from the store
    pub fn clear(&mut self) {
        self.count = 0;
        self.data_end = self.bs().len();
        self.write_header_and_initial_offset();
    }
}

impl<B: ByteStore> Index<usize> for Buffers<B> {
    // The type of the value being indexed
    type Output = [u8];

    // The method that is called when the struct is indexed
    fn index(&self, index: usize) -> &Self::Output {
        self.get(index).unwrap()
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::byte_store::{MMapFile, VecStore};
    use proptest::prelude::*;
    use tempfile::NamedTempFile;

    // A generic test harness for any `ByteStore` implementation.
    // The macro avoids code duplication for `VecStore` and `MMapFile`.
    macro_rules! test_buffers {
        ($test_name:ident, $store_type:expr) => {
            #[test]
            fn $test_name() {
                let store = $store_type;
                let mut buffers = Buffers::new(store);
                check_test_basic_operations(&mut buffers);
                let store = $store_type;
                let mut buffers = Buffers::new(store);
                check_test_auto_growing(&mut buffers);
                let store = $store_type;
                let mut buffers = Buffers::new(store);
                check_test_clear(&mut buffers);
                let store = $store_type;
                let mut buffers = Buffers::new(store);
                check_test_empty_data(&mut buffers);
                let store = $store_type;
                let mut buffers = Buffers::new(store);
                check_test_buffers_slice_and_iter(&mut buffers);
                let store = $store_type;
                let mut buffers = Buffers::new(store);
                check_test_buffers_iter_equivalence(&mut buffers);
            }
        };
    }

    // Run all tests for `VecStore`.
    test_buffers!(test_basic_operations_vec_backend, VecStore::new());

    // Run all tests for `MMapFile`.
    test_buffers!(
        test_basic_operations_mmap_backend,
        MMapFile::new(NamedTempFile::new().unwrap().path(), 1024).unwrap()
    );

    // Test functions, generic over `ByteStore`.
    fn check_test_basic_operations<T: ByteStore>(buffers: &mut Buffers<T>) {
        // Initial state
        assert!(buffers.is_empty());
        assert_eq!(buffers.len(), 0);

        // Append some data
        let idx1 = buffers.append(b"hello");
        assert_eq!(idx1, 0);
        assert_eq!(buffers.len(), 1);
        assert!(!buffers.is_empty());

        let idx2 = buffers.append(b"world");
        assert_eq!(idx2, 1);
        assert_eq!(buffers.len(), 2);

        // Retrieve and verify data
        assert_eq!(buffers.get(0), Some(b"hello".as_ref()));
        assert_eq!(buffers.get(1), Some(b"world".as_ref()));
        assert_eq!(buffers.get(2), None); // Out of bounds

        // Check indexing
        assert_eq!(&buffers[0], b"hello");
        assert_eq!(&buffers[1], b"world");
    }

    fn check_test_auto_growing<T: ByteStore>(buffers: &mut Buffers<T>) {
        let initial_free_space = buffers.free_space();

        // Append data until the buffer needs to grow
        for i in 0..10 {
            let data = format!("data{i}");
            buffers.append(data.as_bytes());
        }

        assert_eq!(buffers.len(), 10);
        assert!(
            buffers.store().as_ref().len() > initial_free_space,
            "Buffer should have grown"
        );
        // Buffer should have grown and be able to accommodate more data
        // Free space may be 0 if calculation was exact, which is fine
        let _ = buffers.free_space(); // Just verify it doesn't panic

        // Verify data integrity after growing
        for i in 0..10 {
            let expected_data = format!("data{i}");
            assert_eq!(buffers.get(i), Some(expected_data.as_bytes()));
        }
    }

    fn check_test_clear<T: ByteStore>(buffers: &mut Buffers<T>) {
        buffers.append(b"some_data");
        buffers.append(b"more_data");
        assert_eq!(buffers.len(), 2);

        buffers.clear();
        assert!(buffers.is_empty());
        assert_eq!(buffers.len(), 0);
        assert_eq!(buffers.get(0), None);

        // Can append after clearing
        buffers.append(b"after_clear");
        assert_eq!(buffers.len(), 1);
        assert_eq!(buffers.get(0), Some(b"after_clear".as_ref()));
    }

    fn check_test_empty_data<T: ByteStore>(buffers: &mut Buffers<T>) {
        buffers.append(b"");
        buffers.append(b"non-empty");
        buffers.append(b"");

        assert_eq!(buffers.len(), 3);
        assert_eq!(buffers.get(0), Some(b"".as_ref()));
        assert_eq!(buffers.get(1), Some(b"non-empty".as_ref()));
        assert_eq!(buffers.get(2), Some(b"".as_ref()));
    }

    proptest! {
        #[test]
        fn prop_test_store_retrieval(data_list in prop::collection::vec(prop::collection::vec(0u8..255, 0..128), 0..256)) {
            let mut buffers = Buffers::new(VecStore::new());
            for data in &data_list {
                buffers.append(data);
            }

            prop_assert_eq!(buffers.len(), data_list.len());

            for (i, data) in data_list.iter().enumerate() {
                prop_assert_eq!(buffers.get(i), Some(data.as_slice()));
            }
        }
    }

    fn check_test_buffers_slice_and_iter<T: ByteStore>(buffers: &mut Buffers<T>) {
        buffers.append(b"a");
        buffers.append(b"b");
        buffers.append(b"c");
        buffers.append(b"d");
        buffers.append(b"e");

        let slice = buffers.slice(1, 4); // [b, c, d]
        assert_eq!(slice.len(), 3);
        assert_eq!(slice.get(0), Some(b"b".as_ref()));
        assert_eq!(slice.get(1), Some(b"c".as_ref()));
        assert_eq!(slice.get(2), Some(b"d".as_ref()));
        assert_eq!(slice.get(3), None);

        let collected: Vec<&[u8]> = slice.iter().collect();
        assert_eq!(collected, vec![b"b", b"c", b"d"]);
    }

    fn check_test_buffers_iter_equivalence<T: ByteStore>(buffers: &mut Buffers<T>) {
        buffers.append(b"a");
        buffers.append(b"b");
        buffers.append(b"c");

        let from_buffers: Vec<&[u8]> = buffers.iter().collect();
        let from_slice: Vec<&[u8]> = buffers.slice(0, buffers.len()).iter().collect();
        assert_eq!(from_buffers, from_slice);
        assert_eq!(
            from_buffers,
            vec![b"a".as_ref(), b"b".as_ref(), b"c".as_ref()]
        );
    }

    proptest! {
        #[test]
        fn prop_slice_iter_equivalence(
            data_list in prop::collection::vec(prop::collection::vec(0u8..255, 0..128), 0..256),
            start_pct in 0.0f64..1.0,
            end_pct in 0.0f64..1.0
        ) {
            let mut buffers = Buffers::new(VecStore::with_capacity(data_list.len() * 100));
            for data in &data_list {
                buffers.append(data);
            }

            let len = buffers.len();
            if len > 0 {
                let start_idx = (start_pct * len as f64).floor() as usize;
                let end_idx = (end_pct * len as f64).floor() as usize;

                if start_idx <= end_idx {
                    let slice = buffers.slice(start_idx, end_idx);
                    let from_slice_iter: Vec<&[u8]> = slice.iter().collect();
                    let expected: Vec<&[u8]> = data_list[start_idx..end_idx].iter().map(|v| v.as_slice()).collect();
                    prop_assert_eq!(from_slice_iter, expected);
                }
            }
        }
    }

    proptest! {
        #[test]
        fn prop_nested_slice_equivalence(
            data_list in prop::collection::vec(prop::collection::vec(0u8..255, 0..32), 10..40)
        ) {
            let mut buffers = Buffers::new(VecStore::with_capacity(data_list.len() * 40));
            for data in &data_list {
                buffers.append(data);
            }

            let slice1 = buffers.slice(2, 8); // 6 elements
            let slice2 = slice1.slice(1, 5); // 4 elements from index 1 of slice1

            let collected: Vec<_> = slice2.iter().collect();
            let expected: Vec<_> = data_list[3..7].iter().map(|v| v.as_slice()).collect();
            prop_assert_eq!(collected, expected);
        }
    }

    proptest! {
        #[test]
        fn prop_test_store_bounds(
            data_list in prop::collection::vec(prop::collection::vec(0u8..255, 0..128), 0..256)
        ) {
            let mut buffers = Buffers::new(VecStore::new());
            for data in &data_list {
                buffers.append(data);
            }

            prop_assert!(buffers.get(data_list.len()).is_none());
            if !data_list.is_empty() {
                prop_assert!(buffers.get(data_list.len() - 1).is_some());
            }
        }
    }

    proptest! {
        #[test]
        fn prop_test_no_out_of_bounds_access(
            data_list in prop::collection::vec(prop::collection::vec(0u8..255, 0..128), 0..256)
        ) {
            let mut buffers = Buffers::new(VecStore::with_capacity(1024 * 1024));
            for data in &data_list {
                buffers.append(data);
            }

            // The test is that this doesn't panic
            for i in 0..buffers.len() {
                let _ = buffers.get(i);
            }
            let _ = buffers.get(buffers.len());
        }
    }

    proptest! {
        #[test]
        fn prop_test_free_space_calculation(
            data_list in prop::collection::vec(prop::collection::vec(0u8..255, 0..128), 0..256)
        ) {
            let mut buffers = Buffers::new(VecStore::with_capacity(1024));
            for data in &data_list {
                buffers.append(data);
            }

            // This assertion is tricky because of buffer growth, so we just check for correctness.
            assert_eq!(buffers.free_space(), buffers.data_end - buffers.offsets_end());
        }
    }

    proptest! {
        #[test]
        fn proptest_free_space_calculation_empty(
             data_list: Vec<Vec<u8>>
        ) {
            let mut buffers = Buffers::new(VecStore::with_capacity(0));
            assert!(buffers.free_space() == 0);

            for data in &data_list {
                buffers.append(data);
            }

            // This assertion is tricky because of buffer growth, so we just check for correctness.
            assert_eq!(buffers.free_space(), buffers.data_end - buffers.offsets_end());
        }
    }

    // A test to ensure that the layout of data and offsets is as expected.
    // This helps in debugging and understanding the internal structure.
    #[test]
    fn test_exact_interface_requirements() {
        let mut buffers = Buffers::new(VecStore::with_capacity(128));
        buffers.append([1, 2]); // len=2, prefix=8, total aligned = 16
        buffers.append([3, 4, 5]); // len=3, prefix=8, total aligned = 16

        let _data_bytes = buffers.store().as_ref();

        // Offsets section: now reflects aligned storage size
        let offsets = buffers.offsets();
        assert_eq!(offsets[0], 0);
        assert_eq!(offsets[1], 16); // Cumulative length of first item (8 + 2 + 6 padding)
        assert_eq!(offsets[2], 32); // Cumulative length of both items (16 + 16)

        // Data section (at the end of the buffer) - get() returns original data
        assert_eq!(buffers.get(0).unwrap(), &[1, 2]);
        assert_eq!(buffers.get(1).unwrap(), &[3, 4, 5]);
    }

    // This test visualizes the buffer layout to help understand the offset system.
    #[test]
    fn test_offset_system_understanding() {
        let mut buffers = Buffers::new(VecStore::with_capacity(64));
        buffers.append([1]); // len=1, prefix=8, total aligned = 16
        buffers.append([2, 2]); // len=2, prefix=8, total aligned = 16  
        buffers.append([3, 3, 3]); // len=3, prefix=8, total aligned = 16

        let offsets = buffers.offsets();
        assert_eq!(offsets[0], 0);
        assert_eq!(offsets[1], 16); // First item: 8 + 1 + 7 padding = 16
        assert_eq!(offsets[2], 32); // Second item: 16 + (8 + 2 + 6 padding) = 32
        assert_eq!(offsets[3], 48); // Third item: 32 + (8 + 3 + 5 padding) = 48

        assert_eq!(buffers.get(0).unwrap(), [1]);
        assert_eq!(buffers.get(1).unwrap(), [2, 2]);
        assert_eq!(buffers.get(2).unwrap(), [3, 3, 3]);
    }

    #[test]
    fn test_empty_buffer() {
        let mut buffers = Buffers::new(VecStore::with_capacity(64));
        check_test_empty_data(&mut buffers);
    }

    #[test]
    fn test_load() {
        let mut store = VecStore::with_capacity(128);
        let mut buffers = Buffers::new(store);
        buffers.append(b"hello");
        buffers.append(b"world");

        // "move" the store to a new Buffers instance
        store = buffers.byte_store;
        let buffers2 = Buffers::load(store);

        assert_eq!(buffers2.len(), 2);
        assert_eq!(buffers2.get(0).unwrap(), b"hello");
        assert_eq!(buffers2.get(1).unwrap(), b"world");
    }

    #[test]
    fn test_offset_system_with_growth() {
        // Start with a small buffer to force growth
        let mut buffers = Buffers::new(VecStore::with_capacity(32));
        buffers.append([1; 10]); // len=10, prefix=8, total aligned = 24
        buffers.append([2; 10]); // len=10, prefix=8, total aligned = 24

        assert_eq!(buffers.len(), 2);
        assert!(buffers.store().as_ref().len() > 32); // It grew

        let offsets = buffers.offsets();
        assert_eq!(offsets[0], 0);
        assert_eq!(offsets[1], 24); // First item: 8 + 10 + 6 padding = 24
        assert_eq!(offsets[2], 48); // Second item: 24 + 24 = 48

        assert_eq!(buffers.get(0).unwrap(), &[1; 10]);
        assert_eq!(buffers.get(1).unwrap(), &[2; 10]);
    }

    // This test checks a very specific scenario that might cause issues with offset calculations.
    #[test]
    fn test_detailed_offset_analysis() {
        let mut buffers = Buffers::new(VecStore::with_capacity(64));
        buffers.append([1, 2]); // Cumulative len = 2
        buffers.append([3, 4, 5]); // Cumulative len = 5
        buffers.append([6]); // Cumulative len = 6

        assert_eq!(buffers.get(0), Some(&[1, 2][..]));
        assert_eq!(buffers.get(1), Some(&[3, 4, 5][..]));
        assert_eq!(buffers.get(2), Some(&[6][..]));
    }
}