karmaio 0.1.0

A modern, fast, share-nothing asynchronous runtime for Rust
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
use std::io;

use crate::{
    buf::{IoBuf, IoBufExt, IoBufMut, IoBufMutExt, Slice},
    io::framed::buffer::append,
};

const DEFAULT_MAX_FRAME_LENGTH: usize = 8 * 1024 * 1024;

/// An extracted frame describing where the payload sits inside a buffer.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct Frame {
    /// Offset where the frame payload starts.
    prefix: usize,
    /// Length of the frame payload.
    payload: usize,
    /// Suffix length after the payload, such as a delimiter.
    suffix: usize,
}

impl Frame {
    /// Create a new [`Frame`] with the specified prefix, payload, and suffix lengths.
    #[inline]
    pub fn new(prefix: usize, payload: usize, suffix: usize) -> Self {
        Self {
            prefix,
            payload,
            suffix,
        }
    }

    /// Length of the entire frame (prefix + payload + suffix).
    #[inline]
    pub fn len(&self) -> usize {
        self.prefix + self.payload + self.suffix
    }

    /// Returns true if the frame has zero total length.
    #[inline]
    pub fn is_empty(&self) -> bool {
        self.len() == 0
    }

    /// Prefix (header) length in bytes.
    #[inline]
    pub fn prefix(&self) -> usize {
        self.prefix
    }

    /// Payload length in bytes.
    #[inline]
    pub fn payload(&self) -> usize {
        self.payload
    }

    /// Suffix length in bytes.
    #[inline]
    pub fn suffix(&self) -> usize {
        self.suffix
    }

    pub(super) fn checked_bounds(&self, available: usize) -> io::Result<(std::ops::Range<usize>, usize)> {
        let payload_end = self.prefix.checked_add(self.payload).ok_or_else(invalid_frame)?;
        let frame_end = payload_end.checked_add(self.suffix).ok_or_else(invalid_frame)?;
        if frame_end == 0 || frame_end > available {
            return Err(invalid_frame());
        }
        Ok((self.prefix..payload_end, frame_end))
    }

    /// Slice the payload out of an owned buffer as an owned [`Slice`] view.
    #[inline]
    pub fn slice<B: IoBuf>(&self, buf: B) -> Slice<B> {
        buf.slice(self.prefix..self.prefix + self.payload)
    }
}

fn invalid_frame() -> io::Error {
    io::Error::new(io::ErrorKind::InvalidData, "framer returned invalid frame bounds")
}

/// Enclosing and extracting frames in an owned buffer.
pub trait Framer<B: IoBufMut> {
    /// Enclose a frame around the currently initialized bytes of `buf` in-place.
    ///
    /// All initialized bytes (`0..bytes_init`) are valid payload that must be
    /// enclosed. Implementations may reserve, shift data with
    /// [`IoBufMutExt::copy_within`], or append a delimiter.
    ///
    /// # Errors
    ///
    /// Returns an error when the payload cannot be represented or the buffer
    /// cannot grow to hold the enclosing bytes.
    fn enclose(&mut self, buf: &mut B) -> io::Result<()>;

    /// Extract a frame from the given buffer view.
    ///
    /// Returns:
    /// - `Ok(Some(frame))` if a complete frame is found
    /// - `Ok(None)` if more data is needed
    /// - `Err` if the data is malformed
    fn extract(&mut self, buf: &Slice<B>) -> io::Result<Option<Frame>>;

    /// Extract a frame when the underlying stream has reached EOF.
    ///
    /// Default: same as [`Framer::extract`]. Delimiter framers override this to
    /// yield a final frame without a trailing delimiter. Length-delimited framers
    /// treat incomplete residual data as an error.
    fn extract_eof(&mut self, buf: &Slice<B>) -> io::Result<Option<Frame>> {
        self.extract(buf)
    }
}

/// Frames data with a big-endian (by default) length prefix.
///
/// Layout: `[length: N bytes][payload: length bytes]`
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct LengthDelimited {
    length_field_len: usize,
    length_field_is_big_endian: bool,
    max_frame_length: usize,
}

impl Default for LengthDelimited {
    fn default() -> Self {
        Self {
            length_field_len: 4,
            length_field_is_big_endian: true,
            max_frame_length: DEFAULT_MAX_FRAME_LENGTH,
        }
    }
}

impl LengthDelimited {
    const MAX_LFL: usize = 8;

    /// Creates a new length-delimited framer with a 4-byte big-endian length field.
    #[inline]
    pub fn new() -> Self {
        Self::default()
    }

    /// Returns the length of the length field in bytes.
    #[inline]
    pub fn length_field_len(&self) -> usize {
        self.length_field_len
    }

    /// Sets the length of the length field in bytes (1..=8).
    ///
    /// # Panics
    ///
    /// Panics unless `len_field_len` is between 1 and 8, inclusive.
    pub fn set_length_field_len(mut self, len_field_len: usize) -> Self {
        assert!(
            len_field_len > 0 && len_field_len <= Self::MAX_LFL,
            "length field must be between 1 and 8 bytes"
        );
        self.length_field_len = len_field_len;
        self
    }

    /// Returns whether the length field is big-endian.
    #[inline]
    pub fn length_field_is_big_endian(&self) -> bool {
        self.length_field_is_big_endian
    }

    /// Sets whether the length field is big-endian.
    #[inline]
    pub fn set_length_field_is_big_endian(mut self, big_endian: bool) -> Self {
        self.length_field_is_big_endian = big_endian;
        self
    }

    /// Returns the largest payload accepted from or written to the wire.
    #[inline]
    pub fn max_frame_length(&self) -> usize {
        self.max_frame_length
    }

    /// Sets the largest payload accepted from or written to the wire.
    #[inline]
    pub fn set_max_frame_length(mut self, max_frame_length: usize) -> Self {
        self.max_frame_length = max_frame_length;
        self
    }
}

impl<B: IoBufMut + IoBufMutExt> Framer<B> for LengthDelimited {
    fn enclose(&mut self, buf: &mut B) -> io::Result<()> {
        let len = IoBuf::as_init(buf).len();
        let lfl = self.length_field_len;

        let len_u64 = u64::try_from(len)
            .map_err(|_| io::Error::new(io::ErrorKind::InvalidInput, "frame payload length exceeds u64"))?;
        if len > self.max_frame_length {
            return Err(io::Error::new(
                io::ErrorKind::InvalidInput,
                "frame payload length exceeds configured maximum",
            ));
        }
        let max_payload = if lfl == Self::MAX_LFL {
            u64::MAX
        } else {
            (1_u64 << (lfl * 8)) - 1
        };
        if len_u64 > max_payload {
            return Err(io::Error::new(
                io::ErrorKind::InvalidInput,
                "frame payload length does not fit the configured length field",
            ));
        }
        let enclosed_len = (lfl as u64)
            .checked_add(len_u64)
            .and_then(|v| usize::try_from(v).ok())
            .ok_or_else(|| io::Error::new(io::ErrorKind::InvalidInput, "enclosed frame length overflow"))?;

        buf.reserve(lfl)?;
        if buf.as_uninit().len() < enclosed_len {
            return Err(io::Error::other(
                "buffer reserve did not provide space for the framed payload",
            ));
        }
        // Shift payload right to make room for the length prefix.
        buf.copy_within(0..len, lfl);

        let len_bytes = if self.length_field_is_big_endian {
            len_u64.to_be_bytes()
        } else {
            len_u64.to_le_bytes()
        };
        let prefix = if self.length_field_is_big_endian {
            &len_bytes[Self::MAX_LFL - lfl..]
        } else {
            &len_bytes[..lfl]
        };

        // Safety: the prefix destination is in the uniquely borrowed buffer,
        // `copy_within` initialized the shifted payload, and `set_len` is only
        // called after every byte in the enlarged initialized range was written.
        unsafe {
            std::ptr::copy_nonoverlapping(prefix.as_ptr(), buf.as_uninit().as_mut_ptr().cast::<u8>(), lfl);
            buf.set_len(enclosed_len);
        }
        Ok(())
    }

    fn extract(&mut self, buf: &Slice<B>) -> io::Result<Option<Frame>> {
        // Use the initialized view (`Deref`), not `Slice::len()` which is the
        // full capacity window and may include uninitialized tail space.
        let data: &[u8] = buf;
        let lfl = self.length_field_len;
        if data.len() < lfl {
            return Ok(None);
        }

        let mut len_bytes = [0u8; Self::MAX_LFL];
        let encoded_len = if self.length_field_is_big_endian {
            len_bytes[Self::MAX_LFL - lfl..].copy_from_slice(&data[..lfl]);
            u64::from_be_bytes(len_bytes)
        } else {
            len_bytes[..lfl].copy_from_slice(&data[..lfl]);
            u64::from_le_bytes(len_bytes)
        };
        let payload_len = usize::try_from(encoded_len)
            .map_err(|_| io::Error::new(io::ErrorKind::InvalidData, "decoded payload length exceeds usize"))?;
        if payload_len > self.max_frame_length {
            return Err(io::Error::new(
                io::ErrorKind::InvalidData,
                "decoded frame length exceeds configured maximum",
            ));
        }

        let frame_len = lfl
            .checked_add(payload_len)
            .ok_or_else(|| io::Error::new(io::ErrorKind::InvalidData, "decoded frame length overflow"))?;
        if data.len() < frame_len {
            return Ok(None);
        }

        Ok(Some(Frame::new(lfl, payload_len, 0)))
    }

    fn extract_eof(&mut self, buf: &Slice<B>) -> io::Result<Option<Frame>> {
        match self.extract(buf)? {
            Some(frame) => Ok(Some(frame)),
            None => {
                let data: &[u8] = buf;
                if data.is_empty() {
                    Ok(None)
                } else {
                    Err(io::Error::new(
                        io::ErrorKind::UnexpectedEof,
                        "bytes remaining on stream",
                    ))
                }
            }
        }
    }
}

/// Delimiter that uses a single character encoded as UTF-8.
///
/// If you need to use a multi-byte delimiter or other encodings, consider using [`AnyDelimited`].
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct CharDelimited<const C: char> {
    char_buf: [u8; 4],
    next_index: usize,
    max_length: usize,
}

impl<const C: char> Default for CharDelimited<C> {
    fn default() -> Self {
        Self::new()
    }
}

impl<const C: char> CharDelimited<C> {
    /// Creates a new character-delimited framer.
    #[inline]
    pub fn new() -> Self {
        Self {
            char_buf: [0; 4],
            next_index: 0,
            max_length: DEFAULT_MAX_FRAME_LENGTH,
        }
    }

    /// Creates a delimiter framer with a maximum inbound payload length.
    #[inline]
    pub fn new_with_max_length(max_length: usize) -> Self {
        Self {
            max_length,
            ..Self::new()
        }
    }

    /// Returns the maximum inbound payload length.
    #[inline]
    pub fn max_length(&self) -> usize {
        self.max_length
    }

    /// Sets the maximum inbound payload length.
    #[inline]
    pub fn set_max_length(mut self, max_length: usize) -> Self {
        self.max_length = max_length;
        self
    }

    fn delimiter_bytes(&mut self) -> &[u8] {
        C.encode_utf8(&mut self.char_buf).as_bytes()
    }
}

impl<B: IoBufMut + IoBufMutExt, const C: char> Framer<B> for CharDelimited<C> {
    fn enclose(&mut self, buf: &mut B) -> io::Result<()> {
        let delim = {
            let bytes = C.encode_utf8(&mut self.char_buf).as_bytes();
            // Copy to stack so we can release the borrow on self.char_buf.
            let mut tmp = [0u8; 4];
            let n = bytes.len();
            tmp[..n].copy_from_slice(bytes);
            (tmp, n)
        };
        append(buf, &delim.0[..delim.1])
    }

    fn extract(&mut self, buf: &Slice<B>) -> io::Result<Option<Frame>> {
        let data: &[u8] = buf;
        let (delimiter, delim_len) = {
            let delim = self.delimiter_bytes();
            let mut delimiter = [0; 4];
            delimiter[..delim.len()].copy_from_slice(delim);
            (delimiter, delim.len())
        };
        let delim = &delimiter[..delim_len];
        extract_delimited(data, delim, &mut self.next_index, self.max_length)
    }

    fn extract_eof(&mut self, buf: &Slice<B>) -> io::Result<Option<Frame>> {
        if let Some(frame) = self.extract(buf)? {
            return Ok(Some(frame));
        }
        let data: &[u8] = buf;
        if data.is_empty() {
            self.next_index = 0;
            Ok(None)
        } else if data.len() > self.max_length {
            self.next_index = 0;
            Err(delimited_frame_too_large())
        } else {
            // Final line without trailing delimiter.
            self.next_index = 0;
            Ok(Some(Frame::new(0, data.len(), 0)))
        }
    }
}

/// Delimiter that uses an arbitrary byte sequence.
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct AnyDelimited<'a> {
    bytes: &'a [u8],
    next_index: usize,
    max_length: usize,
}

impl<'a> AnyDelimited<'a> {
    /// Creates a new delimiter framer with the given delimiter bytes.
    ///
    /// # Panics
    ///
    /// Panics if `bytes` is empty because an empty byte sequence cannot make
    /// framing progress.
    #[inline]
    pub fn new(bytes: &'a [u8]) -> Self {
        assert!(!bytes.is_empty(), "delimiter must not be empty");
        Self {
            bytes,
            next_index: 0,
            max_length: DEFAULT_MAX_FRAME_LENGTH,
        }
    }

    /// Creates a delimiter framer with a maximum inbound payload length.
    ///
    /// # Panics
    ///
    /// Panics if `bytes` is empty.
    #[inline]
    pub fn new_with_max_length(bytes: &'a [u8], max_length: usize) -> Self {
        Self {
            max_length,
            ..Self::new(bytes)
        }
    }

    /// Returns the maximum inbound payload length.
    #[inline]
    pub fn max_length(&self) -> usize {
        self.max_length
    }

    /// Sets the maximum inbound payload length.
    #[inline]
    pub fn set_max_length(mut self, max_length: usize) -> Self {
        self.max_length = max_length;
        self
    }
}

impl<B: IoBufMut + IoBufMutExt> Framer<B> for AnyDelimited<'_> {
    fn enclose(&mut self, buf: &mut B) -> io::Result<()> {
        append(buf, self.bytes)
    }

    fn extract(&mut self, buf: &Slice<B>) -> io::Result<Option<Frame>> {
        let data: &[u8] = buf;
        extract_delimited(data, self.bytes, &mut self.next_index, self.max_length)
    }

    fn extract_eof(&mut self, buf: &Slice<B>) -> io::Result<Option<Frame>> {
        if let Some(frame) = self.extract(buf)? {
            return Ok(Some(frame));
        }
        let data: &[u8] = buf;
        if data.is_empty() {
            self.next_index = 0;
            Ok(None)
        } else if data.len() > self.max_length {
            self.next_index = 0;
            Err(delimited_frame_too_large())
        } else {
            self.next_index = 0;
            Ok(Some(Frame::new(0, data.len(), 0)))
        }
    }
}

fn extract_delimited(
    data: &[u8],
    delimiter: &[u8],
    next_index: &mut usize,
    max_length: usize,
) -> io::Result<Option<Frame>> {
    if data.is_empty() {
        return Ok(None);
    }

    let delimiter_len = delimiter.len();
    let read_to = data.len().min(max_length.saturating_add(delimiter_len));
    let search_from = (*next_index).min(read_to);
    if let Some(offset) = data[search_from..read_to]
        .windows(delimiter_len)
        .position(|window| window == delimiter)
    {
        let position = search_from + offset;
        *next_index = 0;
        return Ok(Some(Frame::new(0, position, delimiter_len)));
    }

    if data.len() > max_length {
        let possible_delimiter_start = (1..delimiter_len)
            .rev()
            .find(|&overlap| data.ends_with(&delimiter[..overlap]))
            .map(|overlap| data.len() - overlap);
        if possible_delimiter_start.is_none_or(|start| start > max_length) {
            *next_index = 0;
            return Err(delimited_frame_too_large());
        }
    }

    *next_index = read_to.saturating_sub(delimiter_len.saturating_sub(1));
    Ok(None)
}

fn delimited_frame_too_large() -> io::Error {
    io::Error::new(io::ErrorKind::InvalidData, "delimited frame exceeds configured maximum")
}

/// Newline (`\n`) delimited framing.
pub type LineDelimited = CharDelimited<'\n'>;

/// A framer that does not add framing; yields chunks up to `max_size`.
///
/// It simply reserves space in the buffer without adding any framing.
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct NoopFramer {
    max_size: usize,
}

impl Default for NoopFramer {
    fn default() -> Self {
        Self { max_size: 4096 }
    }
}

impl NoopFramer {
    /// Creates a new no-op framer with a 4 KiB maximum chunk size.
    #[inline]
    pub fn new() -> Self {
        Self::default()
    }

    /// Returns the maximum chunk size.
    #[inline]
    pub fn max_size(&self) -> usize {
        self.max_size
    }

    /// Sets the maximum chunk size.
    #[inline]
    pub fn set_max_size(mut self, max_size: usize) -> Self {
        assert!(max_size > 0, "no-op frame size must be non-zero");
        self.max_size = max_size;
        self
    }
}

impl<B: IoBufMut> Framer<B> for NoopFramer {
    fn enclose(&mut self, _buf: &mut B) -> io::Result<()> {
        Ok(())
    }

    fn extract(&mut self, buf: &Slice<B>) -> io::Result<Option<Frame>> {
        let data: &[u8] = buf;
        if data.is_empty() {
            return Ok(None);
        }
        let len = data.len().min(self.max_size);
        Ok(Some(Frame::new(0, len, 0)))
    }
}

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

    #[test]
    fn length_delimited_enclose_extract() {
        let mut framer = LengthDelimited::new();
        let mut buf = Vec::from(&b"hello"[..]);
        framer.enclose(&mut buf).unwrap();
        assert_eq!(&buf[..9], b"\x00\x00\x00\x05hello");

        let view = buf.slice(..);
        let frame = framer.extract(&view).unwrap().unwrap();
        assert_eq!(frame, Frame::new(4, 5, 0));
        let payload = frame.slice(view.into_inner());
        assert_eq!(&payload[..], b"hello");
    }

    #[test]
    fn length_delimited_partial() {
        let mut framer = LengthDelimited::new();
        let buf = vec![0u8, 0, 0, 5, b'h', b'e'];
        let view = buf.slice(..);
        assert!(framer.extract(&view).unwrap().is_none());
    }

    #[test]
    fn length_delimited_rejects_payload_that_does_not_fit_field() {
        let mut framer = LengthDelimited::new().set_length_field_len(1);
        let mut buf = vec![0; 256];
        let error = framer.enclose(&mut buf).unwrap_err();
        assert_eq!(error.kind(), io::ErrorKind::InvalidInput);
        assert_eq!(buf.len(), 256);
    }

    #[test]
    fn length_delimited_enforces_configured_maximum() {
        let mut framer = LengthDelimited::new().set_max_frame_length(3);
        let mut payload = b"four".to_vec();
        assert_eq!(
            framer.enclose(&mut payload).unwrap_err().kind(),
            io::ErrorKind::InvalidInput
        );

        let view = b"\0\0\0\x04four".to_vec().slice(..);
        assert_eq!(framer.extract(&view).unwrap_err().kind(), io::ErrorKind::InvalidData);
    }

    #[test]
    fn delimiter_scan_resumes_near_the_previous_end() {
        let mut framer = AnyDelimited::new(b"END");
        let first = b"abcdefghijEN".to_vec().slice(..);
        assert!(framer.extract(&first).unwrap().is_none());
        assert_eq!(framer.next_index, 10);

        let second = b"abcdefghijEND".to_vec().slice(..);
        assert_eq!(framer.extract(&second).unwrap(), Some(Frame::new(0, 10, 3)));
        assert_eq!(framer.next_index, 0);
    }

    #[test]
    fn delimiter_enforces_configured_maximum() {
        let mut framer = AnyDelimited::new_with_max_length(b"\n", 3);
        let view = b"four".to_vec().slice(..);
        assert_eq!(framer.extract(&view).unwrap_err().kind(), io::ErrorKind::InvalidData);
    }

    #[test]
    fn byte_delimiter_allows_a_fragment_after_the_maximum_payload() {
        let mut framer = AnyDelimited::new_with_max_length(b"END", 3);
        let partial = b"abcE".to_vec().slice(..);
        assert!(framer.extract(&partial).unwrap().is_none());

        let complete = b"abcEND".to_vec().slice(..);
        assert_eq!(framer.extract(&complete).unwrap(), Some(Frame::new(0, 3, 3)));
    }

    #[test]
    fn character_delimiter_allows_a_fragment_after_the_maximum_payload() {
        let mut framer = CharDelimited::<'ℝ'>::new_with_max_length(3);
        let delimiter = "ℝ".as_bytes();

        let mut partial = b"abc".to_vec();
        partial.extend_from_slice(&delimiter[..2]);
        assert!(framer.extract(&partial.slice(..)).unwrap().is_none());

        let mut complete = b"abc".to_vec();
        complete.extend_from_slice(delimiter);
        assert_eq!(framer.extract(&complete.slice(..)).unwrap(), Some(Frame::new(0, 3, 3)));
    }

    #[test]
    fn fragmented_delimiter_does_not_hide_an_oversized_payload() {
        let mut framer = AnyDelimited::new_with_max_length(b"END", 3);
        let view = b"abcdE".to_vec().slice(..);
        assert_eq!(framer.extract(&view).unwrap_err().kind(), io::ErrorKind::InvalidData);
    }

    #[test]
    fn eof_rejects_a_partial_delimiter_beyond_the_maximum_payload() {
        let mut framer = AnyDelimited::new_with_max_length(b"END", 3);
        let view = b"abcE".to_vec().slice(..);
        assert_eq!(
            framer.extract_eof(&view).unwrap_err().kind(),
            io::ErrorKind::InvalidData
        );
    }

    #[test]
    #[should_panic(expected = "delimiter must not be empty")]
    fn delimiter_rejects_an_empty_sequence() {
        let _ = AnyDelimited::new(b"");
    }

    #[cfg(target_pointer_width = "64")]
    #[test]
    fn length_delimited_rejects_decoded_length_overflow() {
        let mut framer = LengthDelimited::new().set_length_field_len(8);
        let view = vec![u8::MAX; 8].slice(..);
        let error = framer.extract(&view).unwrap_err();
        assert_eq!(error.kind(), io::ErrorKind::InvalidData);
    }

    #[test]
    fn frame_bounds_reject_overflow_and_non_progress() {
        assert_eq!(
            Frame::new(usize::MAX, 1, 0).checked_bounds(8).unwrap_err().kind(),
            io::ErrorKind::InvalidData
        );
        assert_eq!(
            Frame::new(0, 0, 0).checked_bounds(8).unwrap_err().kind(),
            io::ErrorKind::InvalidData
        );
    }

    #[test]
    fn test_char_delimited() {
        let mut framer = CharDelimited::<'ℝ'>::new();

        let mut buf = Vec::new();
        IoBufMutExt::extend_from_slice(&mut buf, b"hello");
        framer.enclose(&mut buf).unwrap();
        assert_eq!(&buf[..], "helloℝ".as_bytes());

        let view = buf.slice(..);
        let frame = framer.extract(&view).unwrap().unwrap();
        assert_eq!(frame, Frame::new(0, 5, 3));
        let payload = frame.slice(view);
        assert_eq!(&payload[..], b"hello");
    }

    #[test]
    fn line_delimited() {
        let mut framer = LineDelimited::new();
        let mut buf = Vec::from(&b"hello"[..]);
        framer.enclose(&mut buf).unwrap();
        assert_eq!(&buf[..], b"hello\n");

        let view = buf.slice(..);
        let frame = framer.extract(&view).unwrap().unwrap();
        assert_eq!(frame, Frame::new(0, 5, 1));
        let payload = frame.slice(view);
        assert_eq!(&payload[..], b"hello");
    }

    #[test]
    fn noop_framer() {
        let mut framer = NoopFramer::new().set_max_size(3);
        let buf = Vec::from(&b"hello"[..]);
        let view = buf.slice(..);
        let frame = framer.extract(&view).unwrap().unwrap();
        assert_eq!(frame, Frame::new(0, 3, 0));
    }

    #[test]
    #[should_panic(expected = "no-op frame size must be non-zero")]
    fn noop_framer_rejects_zero_maximum() {
        let _ = NoopFramer::new().set_max_size(0);
    }

    #[test]
    fn line_delimited_extract_eof_without_newline() {
        let mut framer = LineDelimited::new();
        let buf = Vec::from(&b"hello"[..]);
        let view = buf.slice(..);
        assert!(framer.extract(&view).unwrap().is_none());
        let frame = framer.extract_eof(&view).unwrap().unwrap();
        assert_eq!(frame, Frame::new(0, 5, 0));
    }
}