leftover 0.0.2

A BufRead adapter for data spanning buffer boundaries
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
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
use std::ops::{Bound, RangeBounds};

use super::action::{Action, LeftoverAction};
use super::staging::Staging;

/// A view of the saved bytes and the current input chunk.
///
/// Created by [`LeftoverReader::fill_view`](crate::LeftoverReader::fill_view).
/// The [`leftover`](Self::leftover) precedes the [`buffer`](Self::buffer) in
/// the input; either can be empty.
/// Its methods work with these bytes without reading from the source.
#[derive(Debug)]
pub struct LeftoverView<'a> {
    leftover: &'a mut Vec<u8>,
    buf: &'a [u8],
    // The deferred slot is empty when this view is created. Staging consumes
    // this permission, so an action cannot be staged through a borrow. The
    // reader commits it only after this view and its returned slices are no
    // longer borrowed; until then, their backing bytes must remain available.
    staging: Staging<'a>,
}

impl<'a> LeftoverView<'a> {
    #[inline]
    pub(super) fn new(leftover: &'a mut Vec<u8>, buf: &'a [u8], staging: Staging<'a>) -> Self {
        Self {
            leftover,
            buf,
            staging,
        }
    }

    /// Return the current input chunk, excluding the leftover.
    #[inline]
    pub fn buffer(&self) -> &[u8] {
        self.buf
    }

    /// Return bytes saved from earlier chunks.
    #[inline]
    pub fn leftover(&self) -> &[u8] {
        self.leftover
    }

    /// Return a range of the leftover followed by the current chunk.
    ///
    /// The range is measured from the start of the leftover. The returned
    /// slices borrow from the leftover and current chunk, respectively; either
    /// may be empty. The data is not copied.
    ///
    /// Accepts a range with inclusive, exclusive, or open-ended bounds.
    ///
    /// # Panics
    /// Panics if the range starts after it ends or extends beyond the combined
    /// length of the two parts.
    ///
    /// ```
    /// use std::io::BufReader;
    ///
    /// use leftover::LeftoverReader;
    ///
    /// let mut reader = LeftoverReader::new(BufReader::with_capacity(3, b"abcdef".as_slice()));
    /// reader.fill_view()?.accumulate();
    /// let view = reader.fill_view()?;
    /// assert_eq!(view.slice(1..5), (b"bc".as_slice(), b"de".as_slice()));
    /// assert_eq!(view.slice(2..=3), (b"c".as_slice(), b"d".as_slice()));
    /// assert_eq!(view.slice(..2), (b"ab".as_slice(), b"".as_slice()));
    /// assert_eq!(view.get(3), b'd');
    /// assert_eq!(view.take_view(2), b"abcde");
    /// # Ok::<(), std::io::Error>(())
    /// ```
    #[inline]
    #[track_caller]
    pub fn slice(&self, range: impl RangeBounds<usize>) -> (&[u8], &[u8]) {
        let split = self.leftover.len();
        let len = split + self.buf.len();
        let start_bound = range.start_bound().cloned();
        let end_bound = range.end_bound().cloned();

        let end = match end_bound {
            Bound::Included(end) if end >= len => Self::slice_index_fail(0, end, len),
            // end < len, so adding one cannot overflow.
            Bound::Included(end) => end + 1,
            Bound::Excluded(end) if end > len => Self::slice_index_fail(0, end, len),
            Bound::Excluded(end) => end,
            Bound::Unbounded => len,
        };
        let start = match start_bound {
            Bound::Excluded(start) if start >= end => Self::slice_index_fail(start, end, len),
            // start < end, so adding one cannot overflow.
            Bound::Excluded(start) => start + 1,
            Bound::Included(start) if start > end => Self::slice_index_fail(start, end, len),
            Bound::Included(start) => start,
            Bound::Unbounded => 0,
        };
        if start >= split {
            // SAFETY: The checks above establish start <= end <= len. Both
            // bounds are at or after split, so the adjusted range is in buf.
            (&[], unsafe {
                self.buf.get_unchecked(start - split..end - split)
            })
        } else if end > split {
            // SAFETY: start < split < end <= len, so each range is within
            // its respective slice.
            unsafe {
                (
                    self.leftover.get_unchecked(start..),
                    self.buf.get_unchecked(..end - split),
                )
            }
        } else {
            // SAFETY: start <= end <= split, so the range is in leftover.
            (unsafe { self.leftover.get_unchecked(start..end) }, &[])
        }
    }

    /// Return a range of the leftover followed by the current chunk without
    /// checking whether it is in bounds.
    ///
    /// The returned slices borrow from the leftover and current chunk,
    /// respectively. The data is not copied.
    ///
    /// # Safety
    /// `range` must be valid for a slice whose length is the combined length
    /// of the leftover and current chunk. Adjusting exclusive start or inclusive
    /// end bounds must not overflow.
    ///
    /// ```
    /// use leftover::LeftoverReader;
    ///
    /// let mut reader = LeftoverReader::new(b"abcdef".as_slice());
    /// let view = reader.fill_view()?;
    /// // SAFETY: 1..4 lies within the six bytes exposed by the view.
    /// assert_eq!(unsafe { view.slice_unchecked(1..4) }, (b"".as_slice(), b"bcd".as_slice()));
    /// # Ok::<(), std::io::Error>(())
    /// ```
    #[inline]
    #[track_caller]
    pub unsafe fn slice_unchecked(&self, range: impl RangeBounds<usize>) -> (&[u8], &[u8]) {
        let split = self.leftover.len();
        let start_bound = range.start_bound();
        let end_bound = range.end_bound();

        // Check the combined range with the standard library's optional UB
        // diagnostics. The zero-sized slice allocates no memory, and its
        // unused result can be optimized away when UB checks are disabled.
        // SAFETY: The pointer is non-null and aligned, and a slice of `()`
        // occupies no memory regardless of its length.
        let logical = unsafe {
            std::slice::from_raw_parts(
                std::ptr::NonNull::<()>::dangling().as_ptr(),
                split + self.buf.len(),
            )
        };
        // SAFETY: The caller guarantees the range is valid for this length.
        let _ = unsafe { logical.get_unchecked((start_bound.cloned(), end_bound.cloned())) };

        let start = match start_bound {
            Bound::Included(&start) => start,
            Bound::Excluded(&start) => start + 1,
            Bound::Unbounded => 0,
        };
        let end = match end_bound {
            Bound::Included(&end) => end + 1,
            Bound::Excluded(&end) => end,
            Bound::Unbounded => split + self.buf.len(),
        };
        if start >= split {
            // SAFETY: The caller guarantees the range is valid, and this
            // branch places both bounds in the current chunk.
            (&[], unsafe {
                self.buf.get_unchecked(start - split..end - split)
            })
        } else if end > split {
            // SAFETY: The caller guarantees the range is valid. This branch
            // places its start in the leftover and its end in the chunk.
            unsafe {
                (
                    self.leftover.get_unchecked(start..),
                    self.buf.get_unchecked(..end - split),
                )
            }
        } else {
            // SAFETY: The caller guarantees the range is valid, and this
            // branch places both bounds in the leftover.
            (unsafe { self.leftover.get_unchecked(start..end) }, &[])
        }
    }

    /// Return the byte at `index`, counting from the start of the leftover.
    ///
    /// # Panics
    /// Panics if `index` is outside the combined length of the leftover and
    /// current chunk.
    #[inline]
    #[track_caller]
    pub fn get(&self, index: usize) -> u8 {
        let split = self.leftover.len();
        if index < split {
            // SAFETY: This branch checks that the index is in the leftover.
            *unsafe { self.leftover.get_unchecked(index) }
        } else if index - split < self.buf.len() {
            // SAFETY: The preceding branch rules out underflow, and this
            // branch checks that the adjusted index is in the current chunk.
            *unsafe { self.buf.get_unchecked(index - split) }
        } else {
            Self::index_fail(index, split + self.buf.len())
        }
    }

    /// Return the byte at `index` without checking whether it is in bounds.
    ///
    /// `index` counts from the start of the leftover.
    ///
    /// # Safety
    /// `index` must be less than the combined length of the leftover and
    /// current chunk.
    ///
    /// ```
    /// use leftover::LeftoverReader;
    ///
    /// let mut reader = LeftoverReader::new(b"abc".as_slice());
    /// let view = reader.fill_view()?;
    /// // SAFETY: The view contains three bytes.
    /// assert_eq!(unsafe { view.get_unchecked(1) }, b'b');
    /// # Ok::<(), std::io::Error>(())
    /// ```
    #[inline]
    pub unsafe fn get_unchecked(&self, index: usize) -> u8 {
        let split = self.leftover.len();
        // Check the combined index with the standard library's optional UB
        // diagnostics. The zero-sized slice allocates no memory, and its
        // unused result can be optimized away when UB checks are disabled.
        // SAFETY: The pointer is non-null and aligned, and a slice of `()`
        // occupies no memory regardless of its length.
        let logical = unsafe {
            std::slice::from_raw_parts(
                std::ptr::NonNull::<()>::dangling().as_ptr(),
                split + self.buf.len(),
            )
        };
        // SAFETY: The caller guarantees the index is valid for this length.
        let _ = unsafe { logical.get_unchecked(index) };

        if index < split {
            // SAFETY: This branch checks that the index is in the leftover.
            unsafe { *self.leftover.get_unchecked(index) }
        } else {
            // SAFETY: The caller ensures the index is within both parts
            // together, and this branch places it in the current chunk.
            unsafe { *self.buf.get_unchecked(index - split) }
        }
    }

    #[cold]
    #[inline(never)]
    #[track_caller]
    fn index_fail(index: usize, len: usize) -> ! {
        panic!("index out of bounds: the len is {len} but the index is {index}")
    }

    #[cold]
    #[inline(never)]
    #[track_caller]
    fn slice_index_fail(start: usize, end: usize, len: usize) -> ! {
        if start > len {
            panic!("range start index {start} out of range for slice of length {len}");
        }
        if end > len {
            panic!("range end index {end} out of range for slice of length {len}");
        }
        if start > end {
            panic!("slice index starts at {start} but ends at {end}");
        }
        // An inclusive end at len or an excluded start at end is invalid.
        panic!("range end index {end} out of range for slice of length {len}")
    }

    /// Add the current chunk to the leftover.
    ///
    /// Copies all bytes from [`Self::buffer`] to the end of the leftover,
    /// allocating more space if needed. The next view starts with the following
    /// chunk.
    ///
    /// # Panics
    /// Panics if the accumulated data would exceed the maximum vector capacity.
    ///
    /// ```
    /// use std::io::BufReader;
    ///
    /// use leftover::LeftoverReader;
    ///
    /// let input = BufReader::with_capacity(3, b"abcdef".as_slice());
    /// let mut reader = LeftoverReader::new(input);
    /// reader.fill_view()?.accumulate();
    /// let view = reader.fill_view()?;
    /// assert_eq!(view.leftover(), b"abc");
    /// assert_eq!(view.buffer(), b"def");
    /// assert_eq!(view.take_owned(2), b"abcde");
    /// # Ok::<(), std::io::Error>(())
    /// ```
    #[inline]
    pub fn accumulate(self) {
        self.leftover.extend_from_slice(self.buf);
        self.staging
            .stage(Action::new(self.buf.len(), LeftoverAction::None));
    }

    /// Discard the leftover and the first `end` bytes of the current chunk.
    ///
    /// `end` counts only bytes from [`Self::buffer`]; use zero to discard just
    /// the leftover. The discarded bytes are excluded from subsequent views.
    /// This operation does not copy the data.
    ///
    /// # Panics
    /// Panics if `end` exceeds the current chunk's length. In that case, the
    /// leftover and current chunk remain available.
    ///
    /// ```
    /// use std::io::BufReader;
    ///
    /// use leftover::LeftoverReader;
    ///
    /// let mut reader = LeftoverReader::new(BufReader::with_capacity(3, b"abcdef".as_slice()));
    /// reader.fill_view()?.accumulate();
    /// reader.fill_view()?.consume(2); // Discards "abcde".
    /// let view = reader.fill_view()?;
    /// assert!(view.leftover().is_empty());
    /// assert_eq!(view.buffer(), b"f");
    /// # Ok::<(), std::io::Error>(())
    /// ```
    #[inline]
    pub fn consume(self, end: usize) {
        assert!(
            end <= self.buf.len(),
            "end exceeds the current chunk's length"
        );
        self.leftover.clear();
        self.staging.stage(Action::new(end, LeftoverAction::None));
    }

    /// Take the leftover and the first `end` bytes of the current chunk as one
    /// borrowed slice.
    ///
    /// Taken bytes are excluded from subsequent views. `end` counts only bytes
    /// from [`Self::buffer`]; use zero to take just the leftover.
    ///
    /// Borrows the current chunk directly when there is no leftover. Otherwise,
    /// copies the selected bytes into the leftover, allocating more space if needed.
    ///
    /// # Panics
    /// Panics if `end` exceeds the current chunk's length or the combined data
    /// would exceed the maximum vector capacity.
    ///
    /// ```
    /// use leftover::LeftoverReader;
    ///
    /// let mut reader = LeftoverReader::new(b"abcdef".as_slice());
    /// let view = reader.fill_view()?;
    /// assert_eq!(view.take_view(2), b"ab");
    /// assert_eq!(reader.fill_view()?.buffer(), b"cdef");
    /// # Ok::<(), std::io::Error>(())
    /// ```
    #[inline]
    pub fn take_view(self, end: usize) -> &'a [u8] {
        let buf = &self.buf[..end];
        let view = if self.leftover.is_empty() {
            self.staging.stage(Action::new(end, LeftoverAction::None));
            buf
        } else {
            self.leftover.extend_from_slice(buf);
            self.staging.stage(Action::new(end, LeftoverAction::Clear));
            self.leftover.as_slice()
        };
        view
    }

    /// Take the leftover and the first `end` bytes of the current chunk in a
    /// new vector.
    ///
    /// Copies the bytes into a new vector. Taken bytes are excluded from
    /// subsequent views. `end` counts only bytes from [`Self::buffer`]; use zero
    /// to take just the leftover. A nonempty result gets its own allocation.
    ///
    /// # Panics
    /// Panics if `end` exceeds the current chunk's length or the resulting
    /// vector would exceed its maximum capacity.
    ///
    /// ```
    /// use leftover::LeftoverReader;
    ///
    /// let mut reader = LeftoverReader::new(b"abcdef".as_slice());
    /// let owned = reader.fill_view()?.take_owned(2);
    /// assert_eq!(owned, b"ab");
    /// assert_eq!(reader.fill_view()?.buffer(), b"cdef");
    /// # Ok::<(), std::io::Error>(())
    /// ```
    #[inline]
    pub fn take_owned(self, end: usize) -> Vec<u8> {
        let buf = &self.buf[..end];
        let owned = if self.leftover.is_empty() {
            buf.to_vec()
        } else {
            Self::take_owned_with_leftover(self.leftover, buf)
        };
        // The owned result does not borrow leftover; any prefix was cleared
        // above, so committing this action only needs to consume the chunk.
        self.staging.stage(Action::new(end, LeftoverAction::None));
        owned
    }

    // Keep the common case, where a record fits in one chunk, compact.
    #[cold]
    #[inline(never)]
    fn take_owned_with_leftover(leftover: &mut Vec<u8>, buf: &[u8]) -> Vec<u8> {
        let mut owned = Vec::with_capacity(leftover.len() + buf.len());
        owned.extend_from_slice(leftover);
        leftover.clear();
        owned.extend_from_slice(buf);
        owned
    }
}

#[cfg(test)]
mod tests {
    use std::cell::Cell;
    use std::io::{self, BufRead, BufReader, Read};

    use super::super::LeftoverReader;

    #[test]
    fn taking_or_accumulating_from_a_view_never_calls_fill_buf() {
        struct Counted<'a> {
            inner: BufReader<&'static [u8]>,
            fills: &'a Cell<usize>,
        }

        impl Read for Counted<'_> {
            fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
                self.inner.read(buf)
            }
        }

        impl BufRead for Counted<'_> {
            fn fill_buf(&mut self) -> io::Result<&[u8]> {
                self.fills.set(self.fills.get() + 1);
                self.inner.fill_buf()
            }

            fn consume(&mut self, amount: usize) {
                self.inner.consume(amount);
            }
        }

        for owned in [false, true] {
            for prefix in [false, true] {
                let fills = Cell::new(0);
                let source = Counted {
                    inner: BufReader::with_capacity(3, b"abcdef".as_slice()),
                    fills: &fills,
                };
                let mut reader = LeftoverReader::new(source);
                if prefix {
                    let view = reader.fill_view().unwrap();
                    let calls = fills.get();
                    view.accumulate();
                    assert_eq!(fills.get(), calls);
                }
                let view = reader.fill_view().unwrap();
                assert_eq!(view.leftover(), if prefix { &b"abc"[..] } else { &[] });
                let calls = fills.get();
                let expected = if prefix { &b"abcde"[..] } else { &b"ab"[..] };
                if owned {
                    assert_eq!(view.take_owned(2), expected);
                } else {
                    assert_eq!(view.take_view(2), expected);
                }
                assert_eq!(fills.get(), calls);
                let view = reader.fill_view().unwrap();
                assert_eq!(fills.get(), calls + 1);
                assert!(view.leftover().is_empty());
                assert_eq!(view.buffer(), if prefix { b"f" } else { b"c" });
            }
        }
    }

    #[test]
    fn temporary_views_borrow_chunks_and_exclude_taken_bytes() {
        let mut input = BufReader::with_capacity(3, b"abcdef".as_slice());
        let pointer = input.fill_buf().unwrap().as_ptr();
        let mut reader = LeftoverReader::new(input);
        let view = reader.fill_view().unwrap();
        assert!(view.leftover().is_empty());
        assert_eq!(view.buffer(), b"abc");
        assert_eq!(view.buffer().as_ptr(), pointer);

        assert_eq!(view.take_view(2), b"ab");
        let view = reader.fill_view().unwrap();
        assert!(view.leftover().is_empty());
        assert_eq!(view.buffer(), b"c");
        assert_eq!(view.buffer().as_ptr(), pointer.wrapping_add(2));

        view.accumulate();
        let prefix_pointer = reader.leftover.as_ptr();
        let view = reader.fill_view().unwrap();
        assert_eq!(view.leftover(), b"c");
        assert_eq!(view.buffer(), b"def");
        assert_eq!(view.leftover().as_ptr(), prefix_pointer);
        assert_eq!(view.take_view(1), b"cd");

        reader.fill_view().unwrap().accumulate();
        let view = reader.fill_view().unwrap();
        assert_eq!(view.leftover(), b"ef");
        assert!(view.buffer().is_empty());
        assert_eq!(view.take_owned(0), b"ef");
        let view = reader.fill_view().unwrap();
        assert!(view.leftover().is_empty());
        assert!(view.buffer().is_empty());
    }

    #[test]
    fn taking_an_owned_prefix_keeps_the_current_chunk() {
        let mut reader = LeftoverReader::new(BufReader::with_capacity(3, b"abcdef".as_slice()));
        reader.fill_view().unwrap().accumulate();
        let view = reader.fill_view().unwrap();
        assert_eq!(view.leftover(), b"abc");
        assert_eq!(view.buffer(), b"def");
        assert_eq!(view.take_owned(0), b"abc");

        let view = reader.fill_view().unwrap();
        assert!(view.leftover().is_empty());
        assert_eq!(view.buffer(), b"def");
        assert_eq!(view.take_owned(1), b"d");
        assert_eq!(reader.fill_view().unwrap().buffer(), b"ef");
    }

    #[test]
    fn slice_borrows_ranges_across_buffer_boundaries() {
        let data = b"abcdef";
        for split in 0..=data.len() {
            let capacity = if split == 0 { data.len() } else { split };
            let mut reader =
                LeftoverReader::new(BufReader::with_capacity(capacity, data.as_slice()));
            if split != 0 {
                reader.fill_view().unwrap().accumulate();
            }
            let view = reader.fill_view().unwrap();
            assert_eq!(view.leftover().len(), split);
            let total = view.leftover().len() + view.buffer().len();
            assert_eq!(
                [view.slice(..).0, view.slice(..).1].concat(),
                &data[..total]
            );
            // SAFETY: An unbounded range selects the entire view.
            assert_eq!(unsafe { view.slice_unchecked(..) }, view.slice(..));
            for start in 0..=total {
                let (leftover, buffer) = view.slice(start..);
                assert_eq!([leftover, buffer].concat(), &data[start..total]);
                // SAFETY: start is within the combined view.
                assert_eq!(unsafe { view.slice_unchecked(start..) }, (leftover, buffer));
                for end in start..=total {
                    let (leftover, buffer) = view.slice(start..end);
                    assert_eq!([leftover, buffer].concat(), &data[start..end]);
                    // SAFETY: start <= end <= the combined length of the view.
                    assert_eq!(
                        unsafe { view.slice_unchecked(start..end) },
                        (leftover, buffer)
                    );
                    if start < end {
                        let (leftover, buffer) = view.slice(start..=end - 1);
                        assert_eq!([leftover, buffer].concat(), &data[start..end]);
                        // SAFETY: start < end <= the combined length of the view.
                        assert_eq!(
                            unsafe { view.slice_unchecked(start..=end - 1) },
                            (leftover, buffer)
                        );
                    }
                    if !leftover.is_empty() {
                        assert_eq!(leftover.as_ptr(), view.leftover()[start..].as_ptr());
                    }
                    if !buffer.is_empty() {
                        assert_eq!(
                            buffer.as_ptr(),
                            view.buffer()[start.saturating_sub(split)..].as_ptr()
                        );
                    }
                }
            }
            for end in 0..=total {
                let (leftover, buffer) = view.slice(..end);
                assert_eq!([leftover, buffer].concat(), &data[..end]);
                // SAFETY: end is at most the combined length of the view.
                assert_eq!(unsafe { view.slice_unchecked(..end) }, (leftover, buffer));
                if end < total {
                    let (leftover, buffer) = view.slice(..=end);
                    assert_eq!([leftover, buffer].concat(), &data[..=end]);
                    // SAFETY: end is less than the combined length of the view.
                    assert_eq!(unsafe { view.slice_unchecked(..=end) }, (leftover, buffer));
                    assert_eq!(view.get(end), data[end]);
                    // SAFETY: end is less than the combined length of the view.
                    assert_eq!(unsafe { view.get_unchecked(end) }, data[end]);
                }
            }
            if total >= 2 {
                use std::ops::Bound::{Excluded, Included};

                let (leftover, buffer) = view.slice((Excluded(0), Included(1)));
                assert_eq!([leftover, buffer].concat(), &data[1..2]);
                // SAFETY: This range selects index 1, which is within the view.
                assert_eq!(
                    unsafe { view.slice_unchecked((Excluded(0), Included(1))) },
                    (leftover, buffer)
                );
            }
            let buffer_len = view.buffer().len();
            assert_eq!(view.take_owned(buffer_len), &data[..total]);
        }
    }

    #[test]
    fn empty_view_accepts_empty_ranges() {
        use std::ops::Bound::{Excluded, Included, Unbounded};

        let mut reader = LeftoverReader::new(b"".as_slice());
        let view = reader.fill_view().unwrap();
        for range in [
            (Unbounded, Unbounded),
            (Unbounded, Excluded(0)),
            (Included(0), Unbounded),
            (Included(0), Excluded(0)),
        ] {
            assert_eq!(view.slice(range), (b"".as_slice(), b"".as_slice()));
            // SAFETY: Each range selects zero bytes at the start of the view.
            assert_eq!(unsafe { view.slice_unchecked(range) }, view.slice(range));
        }
        for range in [
            (Included(0), Included(0)),
            (Excluded(0), Unbounded),
            (Included(1), Excluded(1)),
        ] {
            assert!(std::panic::catch_unwind(std::panic::AssertUnwindSafe(|| {
                view.slice(range)
            }))
            .is_err());
        }
        assert!(std::panic::catch_unwind(std::panic::AssertUnwindSafe(|| view.get(0))).is_err());
    }

    #[test]
    fn slice_rejects_invalid_ranges_without_consuming_data() {
        let mut reader = LeftoverReader::new(BufReader::with_capacity(3, b"abcdef".as_slice()));
        reader.fill_view().unwrap().accumulate();
        let view = reader.fill_view().unwrap();
        for range in [
            std::ops::Range { start: 4, end: 3 },
            0..7,
            7..7,
            3..usize::MAX,
        ] {
            let result = std::panic::catch_unwind(std::panic::AssertUnwindSafe(|| {
                let _ = view.slice(range);
            }));
            assert!(result.is_err());
        }
        for index in [6, usize::MAX] {
            let result = std::panic::catch_unwind(std::panic::AssertUnwindSafe(|| {
                let _ = view.get(index);
            }));
            assert!(result.is_err());
        }
        assert!(std::panic::catch_unwind(std::panic::AssertUnwindSafe(|| {
            let _ = view.slice(..=usize::MAX);
        }))
        .is_err());
        assert!(std::panic::catch_unwind(std::panic::AssertUnwindSafe(|| {
            let _ = view.slice((
                std::ops::Bound::Excluded(usize::MAX),
                std::ops::Bound::Unbounded,
            ));
        }))
        .is_err());
        assert_eq!(view.take_view(3), b"abcdef");
    }

    #[test]
    fn invalid_ranges_report_the_same_errors_as_standard_bounds() {
        use std::fmt::Debug;
        use std::ops::Bound::{Excluded, Included, Unbounded};
        use std::ops::{Bound, Range, RangeBounds};
        use std::panic::{catch_unwind, AssertUnwindSafe};

        #[derive(Clone, Debug)]
        struct CustomRange(Range<usize>);

        impl RangeBounds<usize> for CustomRange {
            fn start_bound(&self) -> Bound<&usize> {
                self.0.start_bound()
            }

            fn end_bound(&self) -> Bound<&usize> {
                self.0.end_bound()
            }
        }

        fn message(f: impl FnOnce()) -> String {
            let error = catch_unwind(AssertUnwindSafe(f)).expect_err("index must be invalid");
            if let Some(message) = error.downcast_ref::<String>() {
                message.clone()
            } else {
                error.downcast_ref::<&str>().unwrap().to_string()
            }
        }

        fn compare<I>(view: &super::LeftoverView<'_>, input: &[u8], range: I)
        where
            I: Clone + Debug + RangeBounds<usize>,
        {
            let standard = message(|| {
                let bounds = (range.start_bound().cloned(), range.end_bound().cloned());
                let _ = &input[bounds];
            });
            let actual = message(|| {
                let _ = view.slice(range.clone());
            });
            assert_eq!(actual, standard, "range: {range:?}");
        }

        let input = b"abcdef".as_slice();
        for split in [0, 3, 6] {
            let capacity = if split == 0 { input.len() } else { split };
            let mut reader = LeftoverReader::new(BufReader::with_capacity(capacity, input));
            if split != 0 {
                reader.fill_view().unwrap().accumulate();
            }
            let view = reader.fill_view().unwrap();
            let (leftover, buffer) = view.slice(CustomRange(1..5));
            assert_eq!([leftover, buffer].concat(), b"bcde");
            compare(&view, input, CustomRange(1..7));

            for range in [
                Range { start: 4, end: 3 },
                Range { start: 7, end: 3 },
                0..7,
                7..7,
                7..9,
                3..usize::MAX,
            ] {
                compare(&view, input, range);
            }
            for range in [
                std::ops::RangeInclusive::new(4, 2),
                1..=6,
                7..=9,
                2..=usize::MAX,
            ] {
                compare(&view, input, range);
            }
            compare(&view, input, 7..);
            compare(&view, input, ..7);
            compare(&view, input, ..=6);
            compare(&view, input, ..=usize::MAX);
            for range in [
                (Included(7), Excluded(9)),
                (Included(7), Included(9)),
                (Excluded(usize::MAX), Unbounded),
                (Excluded(usize::MAX), Included(usize::MAX)),
                (Unbounded, Included(usize::MAX)),
                (Excluded(2), Excluded(2)),
            ] {
                compare(&view, input, range);
            }
            let mut bounds = vec![Unbounded];
            for value in [0, 1, 2, 5, 6, 7, usize::MAX] {
                bounds.extend([Included(value), Excluded(value)]);
            }
            for &start in &bounds {
                for &end in &bounds {
                    let range = (start, end);
                    match catch_unwind(|| &input[range]) {
                        Ok(expected) => {
                            let (leftover, buffer) = view.slice(range);
                            assert_eq!([leftover, buffer].concat(), expected, "range: {range:?}");
                            // SAFETY: Standard slice indexing accepted these
                            // bounds for the same combined length.
                            assert_eq!(
                                unsafe { view.slice_unchecked(range) },
                                (leftover, buffer),
                                "range: {range:?}"
                            );
                        }
                        Err(_) => compare(&view, input, range),
                    }
                }
            }
            for index in [6, 9, usize::MAX] {
                assert_eq!(
                    message(|| {
                        let _ = input[index];
                    }),
                    message(|| {
                        let _ = view.get(index);
                    })
                );
            }
        }
    }

    #[test]
    fn consume_discards_leftover_and_selected_chunk_bytes() {
        for end in 0..=3 {
            let mut reader = LeftoverReader::new(BufReader::with_capacity(3, b"abcdef".as_slice()));
            reader.fill_view().unwrap().accumulate();
            let view = reader.fill_view().unwrap();
            assert_eq!(view.leftover(), b"abc");
            assert_eq!(view.buffer(), b"def");
            view.consume(end);

            let view = reader.fill_view().unwrap();
            assert!(view.leftover().is_empty());
            assert_eq!(view.buffer(), &b"def"[end..]);
        }

        let mut reader = LeftoverReader::new(b"abcdef".as_slice());
        reader.fill_view().unwrap().consume(2);
        assert_eq!(reader.fill_view().unwrap().buffer(), b"cdef");
        reader.fill_view().unwrap().consume(1);
        assert_eq!(reader.into_inner(), b"def".as_slice());
    }

    #[test]
    fn consume_at_eof_and_out_of_bounds() {
        let mut reader = LeftoverReader::new(BufReader::with_capacity(3, b"abcdef".as_slice()));
        reader.fill_view().unwrap().accumulate();
        let result = std::panic::catch_unwind(std::panic::AssertUnwindSafe(|| {
            reader.fill_view().unwrap().consume(4);
        }));
        assert!(result.is_err());
        let view = reader.fill_view().unwrap();
        assert_eq!(view.leftover(), b"abc");
        assert_eq!(view.buffer(), b"def");
        view.accumulate();
        let view = reader.fill_view().unwrap();
        assert_eq!(view.leftover(), b"abcdef");
        assert!(view.buffer().is_empty());
        view.consume(0);
        let view = reader.fill_view().unwrap();
        assert!(view.leftover().is_empty());
        assert!(view.buffer().is_empty());
    }

    #[test]
    fn empty_chunks_can_preserve_or_take_the_prefix() {
        for owned in [false, true] {
            let mut reader = LeftoverReader::new(b"abc".as_slice());
            reader.fill_view().unwrap().accumulate();
            let view = reader.fill_view().unwrap();
            assert!(view.buffer().is_empty());
            view.accumulate();

            let view = reader.fill_view().unwrap();
            assert_eq!(view.leftover(), b"abc");
            assert!(view.buffer().is_empty());
            if owned {
                assert_eq!(view.take_owned(0), b"abc");
            } else {
                assert_eq!(view.take_view(0), b"abc");
            }
            let view = reader.fill_view().unwrap();
            assert!(view.leftover().is_empty());
            assert!(view.buffer().is_empty());
        }
    }
}