brec 0.6.0

A flexible binary format for storing and streaming structured data as packets with CRC protection and recoverability from corruption. Built for extensibility and robustness.
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
use crate::payload::EncodedPayload;
use crate::*;

/// Implements mutable stream writing for a full `PacketDef`, including header, blocks, and payload.
///
/// This trait supports writing packets to a stream with partial write handling
/// (`write`) and guaranteed complete writes (`write_all`).
///
/// # Behavior
/// - The `PacketHeader` is constructed on the fly based on the current blocks and payload.
/// - `write()` may return early if only part of the data was written.
/// - `write_all()` retries until all data is successfully written.
///
/// # Errors
/// Returns any I/O error or encoding failure from `BlockDef`, `PayloadDef`, or `PayloadHeader`.
impl<B: BlockDef, P: PayloadDef<Inner>, Inner: PayloadInnerDef> WriteMutTo
    for PacketDef<B, P, Inner>
{
    /// Writes the packet to a stream, allowing for partial write detection.
    ///
    /// # Returns
    /// Total number of bytes written. May be less than full packet size if the underlying
    /// writer cannot accept all data in one go.
    ///
    /// Use `write_all()` if full delivery is required.
    fn write<T: std::io::Write>(
        &mut self,
        buf: &mut T,
        ctx: &mut <Self as ProtocolSchema>::Context<'_>,
    ) -> std::io::Result<usize> {
        let prepared_payload = if let Some(payload) = self.payload.as_ref() {
            Some(prepare_payload(payload, ctx)?)
        } else {
            None
        };
        let payload_len = prepared_payload
            .as_ref()
            .map(|(header, body)| (header.size() + body.len()) as u64)
            .unwrap_or(0);
        let blocks_len: u64 = self.blocks.iter().map(|blk| blk.size()).sum();
        let header =
            PacketHeader::from_lengths(blocks_len, payload_len, prepared_payload.is_some());
        let mut total = header.write(buf)?;
        if total < PacketHeader::SIZE as usize {
            return Ok(total);
        }
        for blk in self.blocks.iter() {
            let size = blk.size() as usize;
            let written = blk.write(buf)?;
            if written < size {
                return Ok(total + written);
            }
            total += written;
        }
        if let Some((payload_header, payload_body)) = prepared_payload.as_ref() {
            let payload_header = payload_header.as_vec();
            let written = buf.write(&payload_header)?;
            if written < payload_header.len() {
                return Ok(total + written);
            }
            total += written;

            let written = buf.write(payload_body.as_slice())?;
            if written < payload_body.len() {
                return Ok(total + written);
            }
            total += written;
        }
        Ok(total)
    }

    /// Writes the entire packet to the stream, retrying until all parts are written.
    ///
    /// This includes:
    /// - the computed `PacketHeader`
    /// - each individual block
    /// - optional payload
    fn write_all<T: std::io::Write>(
        &mut self,
        buf: &mut T,
        ctx: &mut <Self as ProtocolSchema>::Context<'_>,
    ) -> std::io::Result<()> {
        let prepared_payload = if let Some(payload) = self.payload.as_ref() {
            Some(prepare_payload(payload, ctx)?)
        } else {
            None
        };
        let payload_len = prepared_payload
            .as_ref()
            .map(|(header, body)| (header.size() + body.len()) as u64)
            .unwrap_or(0);
        let blocks_len: u64 = self.blocks.iter().map(|blk| blk.size()).sum();
        let header =
            PacketHeader::from_lengths(blocks_len, payload_len, prepared_payload.is_some());
        header.write_all(buf)?;
        for blk in self.blocks.iter() {
            blk.write_all(buf)?;
        }
        if let Some((payload_header, payload_body)) = prepared_payload.as_ref() {
            buf.write_all(&payload_header.as_vec())?;
            buf.write_all(payload_body.as_slice())?;
        }
        Ok(())
    }
}

/// Implements vectored I/O writing for `PacketDef` using `IoSlices`.
///
/// This trait allows the entire packet to be described as a collection of contiguous slices,
/// which can then be written efficiently using `write_vectored()` or `write_vectored_all()`.
///
/// # Behavior
/// - Builds a dynamic `IoSlices` buffer including header, blocks, and optional payload.
/// - Encodes the header into a temporary buffer and adds it as the first slice.
/// - Calls `slices()` on each block and the payload (if present).
///
/// # Errors
/// Returns an error if header construction, encoding, or slice generation fails.
impl<B: BlockDef, P: PayloadDef<Inner>, Inner: PayloadInnerDef> WriteVectoredMutTo
    for PacketDef<B, P, Inner>
{
    /// Returns an `IoSlices` collection representing the full serialized packet.
    ///
    /// This includes:
    /// - Serialized header (as buffered bytes)
    /// - Serialized block slices
    /// - Serialized payload slices (if any)
    ///
    /// # Returns
    /// A ready-to-write `IoSlices` that can be passed to `write_vectored`.
    fn slices(
        &mut self,
        ctx: &mut <Self as ProtocolSchema>::Context<'_>,
    ) -> std::io::Result<IoSlices<'_>> {
        let prepared_payload = if let Some(payload) = self.payload.as_ref() {
            Some(prepare_payload(payload, ctx)?)
        } else {
            None
        };
        let payload_len = prepared_payload
            .as_ref()
            .map(|(header, body)| (header.size() + body.len()) as u64)
            .unwrap_or(0);
        let blocks_len: u64 = self.blocks.iter().map(|blk| blk.size()).sum();
        let header =
            PacketHeader::from_lengths(blocks_len, payload_len, prepared_payload.is_some());
        let mut slices = IoSlices::default();
        let mut header_bytes: Vec<u8> = Vec::new();
        header.write_all(&mut header_bytes)?;
        slices.add_buffered(header_bytes);
        for blk in self.blocks.iter() {
            slices.append(blk.slices()?);
        }
        if let Some((payload_header, payload_body)) = prepared_payload {
            slices.add_buffered(payload_header.as_vec());
            match payload_body {
                EncodedPayload::Borrowed(bytes) => slices.add_slice(bytes),
                EncodedPayload::Owned(bytes) => slices.add_buffered(bytes),
            }
        }
        Ok(slices)
    }
}

#[cfg(test)]
mod tests {
    use crate::{
        ByteBlock, DefaultProtocolContext, Error, ExtractPayloadFrom, IoSlices, PacketDef,
        PacketHeader, PayloadCrc, PayloadDef, PayloadEncode, PayloadEncodeReferred, PayloadHeader,
        PayloadHooks, PayloadInnerDef, PayloadSignature, PayloadSize, ProtocolSchema, ReadFrom,
        ReadStatus, TryExtractPayloadFrom, TryExtractPayloadFromBuffered, TryReadFrom,
        TryReadFromBuffered, WriteMutTo, WriteTo, WriteVectoredMutTo, WriteVectoredTo,
    };
    use std::io::{Cursor, Read, Write};

    struct OkBlock(Vec<u8>);

    impl crate::Size for OkBlock {
        fn size(&self) -> u64 {
            self.0.len() as u64
        }
    }

    impl WriteTo for OkBlock {
        fn write<T: std::io::Write>(&self, buf: &mut T) -> std::io::Result<usize> {
            buf.write(self.0.as_slice())
        }
        fn write_all<T: std::io::Write>(&self, buf: &mut T) -> std::io::Result<()> {
            buf.write_all(self.0.as_slice())
        }
    }

    impl WriteVectoredTo for OkBlock {
        fn slices(&self) -> std::io::Result<IoSlices<'_>> {
            let mut slices = IoSlices::default();
            slices.add_slice(self.0.as_slice());
            Ok(slices)
        }
    }

    // These read/extract methods are required by `BlockDef`/`PayloadDef` bounds for
    // packet generics in tests. They are intentional stub implementations that return
    // explicit errors, and we call them in a dedicated test so coverage metrics stay honest.
    impl TryReadFromBuffered for OkBlock {
        fn try_read<T: std::io::BufRead, S: ProtocolSchema>(
            _: &mut T,
        ) -> Result<ReadStatus<Self>, Error> {
            Err(Error::Test)
        }
    }
    impl TryReadFrom for OkBlock {
        fn try_read<T: std::io::Read + std::io::Seek, S: ProtocolSchema>(
            _: &mut T,
        ) -> Result<ReadStatus<Self>, Error> {
            Err(Error::Test)
        }
    }
    impl crate::ReadFrom for OkBlock {
        fn read<T: std::io::Read, S: ProtocolSchema>(_: &mut T) -> Result<Self, Error> {
            Err(Error::Test)
        }
    }
    impl crate::ReadBlockFrom for OkBlock {
        fn read<T: std::io::Read>(_: &mut T, _: bool) -> Result<Self, Error> {
            Err(Error::Test)
        }
    }
    impl crate::ReadBlockFromSlice for OkBlock {
        fn read_from_slice<'a>(_: &'a [u8], _: bool) -> Result<Self, Error>
        where
            Self: 'a + Sized,
        {
            Err(Error::Test)
        }
    }
    impl crate::BlockDef for OkBlock {}

    struct ErrBlock;

    impl crate::Size for ErrBlock {
        fn size(&self) -> u64 {
            1
        }
    }
    impl WriteTo for ErrBlock {
        fn write<T: std::io::Write>(&self, _: &mut T) -> std::io::Result<usize> {
            Err(std::io::Error::other("err block write"))
        }
        fn write_all<T: std::io::Write>(&self, _: &mut T) -> std::io::Result<()> {
            Err(std::io::Error::other("err block write_all"))
        }
    }
    impl WriteVectoredTo for ErrBlock {
        fn slices(&self) -> std::io::Result<IoSlices<'_>> {
            Err(std::io::Error::other("err block slices"))
        }
    }
    impl TryReadFromBuffered for ErrBlock {
        fn try_read<T: std::io::BufRead, S: ProtocolSchema>(
            _: &mut T,
        ) -> Result<ReadStatus<Self>, Error> {
            Err(Error::Test)
        }
    }
    impl TryReadFrom for ErrBlock {
        fn try_read<T: std::io::Read + std::io::Seek, S: ProtocolSchema>(
            _: &mut T,
        ) -> Result<ReadStatus<Self>, Error> {
            Err(Error::Test)
        }
    }
    impl crate::ReadFrom for ErrBlock {
        fn read<T: std::io::Read, S: ProtocolSchema>(_: &mut T) -> Result<Self, Error> {
            Err(Error::Test)
        }
    }
    impl crate::ReadBlockFrom for ErrBlock {
        fn read<T: std::io::Read>(_: &mut T, _: bool) -> Result<Self, Error> {
            Err(Error::Test)
        }
    }
    impl crate::ReadBlockFromSlice for ErrBlock {
        fn read_from_slice<'a>(_: &'a [u8], _: bool) -> Result<Self, Error>
        where
            Self: 'a + Sized,
        {
            Err(Error::Test)
        }
    }
    impl crate::BlockDef for ErrBlock {}

    #[derive(Clone)]
    struct LocalPayload(Vec<u8>);

    impl ProtocolSchema for LocalPayload {
        type Context<'a> = DefaultProtocolContext;
    }
    impl PayloadHooks for LocalPayload {}
    impl PayloadEncode for LocalPayload {
        fn encode(&self, _: &mut Self::Context<'_>) -> std::io::Result<Vec<u8>> {
            Ok(self.0.clone())
        }
    }
    impl PayloadEncodeReferred for LocalPayload {
        fn encode(&self, _: &mut Self::Context<'_>) -> std::io::Result<Option<&[u8]>> {
            Ok(Some(self.0.as_slice()))
        }
    }
    impl PayloadSignature for LocalPayload {
        fn sig(&self) -> ByteBlock {
            ByteBlock::Len4(*b"DATA")
        }
    }
    impl PayloadSize for LocalPayload {}
    impl PayloadCrc for LocalPayload {}
    impl WriteMutTo for LocalPayload {
        fn write<T: std::io::Write>(
            &mut self,
            buf: &mut T,
            _: &mut Self::Context<'_>,
        ) -> std::io::Result<usize> {
            buf.write(self.0.as_slice())
        }
        fn write_all<T: std::io::Write>(
            &mut self,
            buf: &mut T,
            _: &mut Self::Context<'_>,
        ) -> std::io::Result<()> {
            buf.write_all(self.0.as_slice())
        }
    }
    impl WriteVectoredMutTo for LocalPayload {
        fn slices(&mut self, _: &mut Self::Context<'_>) -> std::io::Result<IoSlices<'_>> {
            let mut slices = IoSlices::default();
            slices.add_slice(self.0.as_slice());
            Ok(slices)
        }
    }
    impl PayloadInnerDef for LocalPayload {}
    impl TryExtractPayloadFromBuffered<LocalPayload> for LocalPayload {
        fn try_read<B: std::io::BufRead>(
            _: &mut B,
            _: &PayloadHeader,
            _: &mut <LocalPayload as ProtocolSchema>::Context<'_>,
        ) -> Result<ReadStatus<LocalPayload>, Error> {
            Err(Error::Test)
        }
    }
    impl TryExtractPayloadFrom<LocalPayload> for LocalPayload {
        fn try_read<B: std::io::Read + std::io::Seek>(
            _: &mut B,
            _: &PayloadHeader,
            _: &mut <LocalPayload as ProtocolSchema>::Context<'_>,
        ) -> Result<ReadStatus<LocalPayload>, Error> {
            Err(Error::Test)
        }
    }
    impl ExtractPayloadFrom<LocalPayload> for LocalPayload {
        fn read<B: std::io::Read>(
            _: &mut B,
            _: &PayloadHeader,
            _: &mut <LocalPayload as ProtocolSchema>::Context<'_>,
        ) -> Result<LocalPayload, Error> {
            Err(Error::Test)
        }
    }
    impl PayloadDef<LocalPayload> for LocalPayload {}

    #[derive(Clone)]
    struct OwnedPayload(Vec<u8>);

    impl ProtocolSchema for OwnedPayload {
        type Context<'a> = DefaultProtocolContext;
    }
    impl PayloadHooks for OwnedPayload {}
    impl PayloadEncode for OwnedPayload {
        fn encode(&self, _: &mut Self::Context<'_>) -> std::io::Result<Vec<u8>> {
            Ok(self.0.clone())
        }
    }
    impl PayloadEncodeReferred for OwnedPayload {
        fn encode(&self, _: &mut Self::Context<'_>) -> std::io::Result<Option<&[u8]>> {
            Ok(None)
        }
    }
    impl PayloadSignature for OwnedPayload {
        fn sig(&self) -> ByteBlock {
            ByteBlock::Len4(*b"OWND")
        }
    }
    impl PayloadSize for OwnedPayload {}
    impl PayloadCrc for OwnedPayload {}
    impl WriteMutTo for OwnedPayload {
        fn write<T: std::io::Write>(
            &mut self,
            buf: &mut T,
            _: &mut Self::Context<'_>,
        ) -> std::io::Result<usize> {
            buf.write(self.0.as_slice())
        }
        fn write_all<T: std::io::Write>(
            &mut self,
            buf: &mut T,
            _: &mut Self::Context<'_>,
        ) -> std::io::Result<()> {
            buf.write_all(self.0.as_slice())
        }
    }
    impl WriteVectoredMutTo for OwnedPayload {
        fn slices(&mut self, _: &mut Self::Context<'_>) -> std::io::Result<IoSlices<'_>> {
            let mut slices = IoSlices::default();
            slices.add_slice(self.0.as_slice());
            Ok(slices)
        }
    }
    impl PayloadInnerDef for OwnedPayload {}
    impl TryExtractPayloadFromBuffered<OwnedPayload> for OwnedPayload {
        fn try_read<B: std::io::BufRead>(
            _: &mut B,
            _: &PayloadHeader,
            _: &mut <OwnedPayload as ProtocolSchema>::Context<'_>,
        ) -> Result<ReadStatus<OwnedPayload>, Error> {
            Err(Error::Test)
        }
    }
    impl TryExtractPayloadFrom<OwnedPayload> for OwnedPayload {
        fn try_read<B: std::io::Read + std::io::Seek>(
            _: &mut B,
            _: &PayloadHeader,
            _: &mut <OwnedPayload as ProtocolSchema>::Context<'_>,
        ) -> Result<ReadStatus<OwnedPayload>, Error> {
            Err(Error::Test)
        }
    }
    impl ExtractPayloadFrom<OwnedPayload> for OwnedPayload {
        fn read<B: std::io::Read>(
            _: &mut B,
            _: &PayloadHeader,
            _: &mut <OwnedPayload as ProtocolSchema>::Context<'_>,
        ) -> Result<OwnedPayload, Error> {
            Err(Error::Test)
        }
    }
    impl PayloadDef<OwnedPayload> for OwnedPayload {}

    struct LimitWriter {
        max: usize,
        out: Vec<u8>,
    }

    impl Write for LimitWriter {
        fn write(&mut self, buf: &[u8]) -> std::io::Result<usize> {
            let n = buf.len().min(self.max.max(1));
            self.out.extend_from_slice(&buf[..n]);
            Ok(n)
        }
        fn flush(&mut self) -> std::io::Result<()> {
            Ok(())
        }
    }

    struct ScriptedWriter {
        limits: Vec<usize>,
        call: usize,
        out: Vec<u8>,
    }

    impl Write for ScriptedWriter {
        fn write(&mut self, buf: &[u8]) -> std::io::Result<usize> {
            let limit = self
                .limits
                .get(self.call)
                .copied()
                .unwrap_or(usize::MAX)
                .max(1);
            self.call += 1;
            let n = buf.len().min(limit);
            self.out.extend_from_slice(&buf[..n]);
            Ok(n)
        }

        fn flush(&mut self) -> std::io::Result<()> {
            Ok(())
        }
    }

    #[test]
    fn write_and_write_all_work_for_empty_packet() {
        let mut packet = PacketDef::<OkBlock, LocalPayload, LocalPayload>::default();
        let mut out = Vec::new();
        let written = packet
            .write(&mut out, &mut DefaultProtocolContext::default())
            .expect("write");
        assert_eq!(written, PacketHeader::SIZE as usize);
        assert_eq!(out.len(), PacketHeader::SIZE as usize);

        let mut out_all = Vec::new();
        packet
            .write_all(&mut out_all, &mut DefaultProtocolContext::default())
            .expect("write_all");
        assert_eq!(out_all.len(), PacketHeader::SIZE as usize);
        assert_eq!(out, out_all);
    }

    #[test]
    fn write_returns_partial_when_writer_is_limited() {
        let mut packet = PacketDef::<OkBlock, LocalPayload, LocalPayload>::default();
        let mut writer = LimitWriter {
            max: 3,
            out: Vec::new(),
        };
        let written = packet
            .write(&mut writer, &mut DefaultProtocolContext::default())
            .expect("partial write");
        assert_eq!(written, 3);
        assert_eq!(writer.out.len(), 3);
        writer.flush().expect("flush");
    }

    #[test]
    fn write_with_block_and_payload_matches_write_all() {
        let payload = LocalPayload(vec![9, 8, 7, 6]);
        let mut packet = PacketDef::<OkBlock, LocalPayload, LocalPayload>::new(
            vec![OkBlock(vec![1, 2, 3])],
            Some(payload.clone()),
        );
        let mut out = Vec::new();
        let written = packet
            .write(&mut out, &mut DefaultProtocolContext::default())
            .expect("write");

        let mut out_all = Vec::new();
        let mut packet_all = PacketDef::<OkBlock, LocalPayload, LocalPayload>::new(
            vec![OkBlock(vec![1, 2, 3])],
            Some(payload),
        );
        packet_all
            .write_all(&mut out_all, &mut DefaultProtocolContext::default())
            .expect("write_all");

        assert_eq!(written, out.len());
        assert_eq!(out, out_all);
    }

    #[test]
    fn write_returns_partial_when_block_write_is_short() {
        let mut packet = PacketDef::<OkBlock, LocalPayload, LocalPayload>::new(
            vec![OkBlock(vec![1, 2, 3])],
            None,
        );
        let mut writer = ScriptedWriter {
            limits: vec![PacketHeader::SIZE as usize, 1],
            call: 0,
            out: Vec::new(),
        };

        let written = packet
            .write(&mut writer, &mut DefaultProtocolContext::default())
            .expect("write");
        assert_eq!(written, PacketHeader::SIZE as usize + 1);
    }

    #[test]
    fn write_returns_partial_when_payload_header_is_short() {
        let payload = LocalPayload(vec![10, 20, 30, 40]);
        let payload_header_len =
            PayloadHeader::new(&payload, &mut DefaultProtocolContext::default())
                .expect("payload header")
                .size();
        let mut packet =
            PacketDef::<OkBlock, LocalPayload, LocalPayload>::new(vec![], Some(payload));
        let mut writer = ScriptedWriter {
            limits: vec![PacketHeader::SIZE as usize, payload_header_len - 1],
            call: 0,
            out: Vec::new(),
        };

        let written = packet
            .write(&mut writer, &mut DefaultProtocolContext::default())
            .expect("write");
        assert_eq!(
            written,
            PacketHeader::SIZE as usize + payload_header_len - 1
        );
    }

    #[test]
    fn write_returns_partial_when_payload_body_is_short() {
        let payload = LocalPayload(vec![10, 20, 30, 40]);
        let payload_header_len =
            PayloadHeader::new(&payload, &mut DefaultProtocolContext::default())
                .expect("payload header")
                .size();
        let mut packet =
            PacketDef::<OkBlock, LocalPayload, LocalPayload>::new(vec![], Some(payload.clone()));
        let mut writer = ScriptedWriter {
            limits: vec![
                PacketHeader::SIZE as usize,
                payload_header_len,
                payload.0.len() - 1,
            ],
            call: 0,
            out: Vec::new(),
        };

        let written = packet
            .write(&mut writer, &mut DefaultProtocolContext::default())
            .expect("write");
        assert_eq!(
            written,
            PacketHeader::SIZE as usize + payload_header_len + payload.0.len() - 1
        );
    }

    #[test]
    fn write_and_slices_propagate_block_errors() {
        let mut packet =
            PacketDef::<ErrBlock, LocalPayload, LocalPayload>::new(vec![ErrBlock], None);
        let err = packet
            .write(&mut Vec::new(), &mut DefaultProtocolContext::default())
            .expect_err("block write must fail");
        assert_eq!(err.kind(), std::io::ErrorKind::Other);

        let err = match packet.slices(&mut DefaultProtocolContext::default()) {
            Ok(_) => panic!("block slices must fail"),
            Err(err) => err,
        };
        assert_eq!(err.kind(), std::io::ErrorKind::Other);
    }

    #[test]
    fn write_all_propagates_block_error() {
        let mut packet =
            PacketDef::<ErrBlock, LocalPayload, LocalPayload>::new(vec![ErrBlock], None);
        let err = packet
            .write_all(&mut Vec::new(), &mut DefaultProtocolContext::default())
            .expect_err("block write_all must fail");
        assert_eq!(err.kind(), std::io::ErrorKind::Other);
    }

    #[test]
    fn write_all_and_slices_include_payload() {
        let payload = LocalPayload(vec![10, 20, 30, 40]);
        let mut packet = PacketDef::<OkBlock, LocalPayload, LocalPayload>::new(
            vec![OkBlock(vec![1, 2])],
            Some(payload.clone()),
        );

        let mut out = Vec::new();
        packet
            .write_all(&mut out, &mut DefaultProtocolContext::default())
            .expect("write_all");

        let mut cursor = Cursor::new(out.as_slice());
        let packet_header = PacketHeader::read::<_, ()>(&mut cursor).expect("packet header read");
        assert_eq!(packet_header.blocks_len, 2);
        assert!(packet_header.payload);

        let mut block = [0_u8; 2];
        cursor.read_exact(&mut block).expect("read block");
        assert_eq!(block, [1, 2]);

        let payload_header =
            PayloadHeader::read::<_, ()>(&mut cursor).expect("payload header read");
        assert_eq!(payload_header.payload_len(), 4);
        let mut payload_body = [0_u8; 4];
        cursor
            .read_exact(&mut payload_body)
            .expect("read payload body");
        assert_eq!(payload_body, [10, 20, 30, 40]);

        let mut packet2 = PacketDef::<OkBlock, LocalPayload, LocalPayload>::new(
            vec![OkBlock(vec![1, 2])],
            Some(payload),
        );
        let slices = packet2
            .slices(&mut DefaultProtocolContext::default())
            .expect("slices");
        let mut vectored = Vec::new();
        for s in slices.get() {
            vectored.extend_from_slice(&s);
        }
        assert_eq!(vectored, out);
    }

    #[test]
    fn slices_include_owned_payload_when_referred_is_missing() {
        let payload = OwnedPayload(vec![11, 22, 33, 44]);
        let mut packet = PacketDef::<OkBlock, OwnedPayload, OwnedPayload>::new(
            vec![OkBlock(vec![1, 2])],
            Some(payload.clone()),
        );
        let slices = packet
            .slices(&mut DefaultProtocolContext::default())
            .expect("slices");
        let mut vectored = Vec::new();
        for s in slices.get() {
            vectored.extend_from_slice(&s);
        }

        let mut packet_all = PacketDef::<OkBlock, OwnedPayload, OwnedPayload>::new(
            vec![OkBlock(vec![1, 2])],
            Some(payload),
        );
        let mut out_all = Vec::new();
        packet_all
            .write_all(&mut out_all, &mut DefaultProtocolContext::default())
            .expect("write_all");

        assert_eq!(vectored, out_all);
    }

    #[test]
    fn trait_required_stub_methods_return_explicit_errors() {
        let mut buffered = Cursor::new(Vec::<u8>::new());
        let mut stream = Cursor::new(Vec::<u8>::new());
        let payload_header = PayloadHeader {
            sig: ByteBlock::Len4([0, 0, 0, 0]),
            crc: ByteBlock::Len4([0, 0, 0, 0]),
            len: 0,
        };

        assert!(matches!(
            <OkBlock as TryReadFromBuffered>::try_read::<_, ()>(&mut buffered),
            Err(Error::Test)
        ));
        assert!(matches!(
            <OkBlock as TryReadFrom>::try_read::<_, ()>(&mut stream),
            Err(Error::Test)
        ));
        assert!(matches!(
            <OkBlock as crate::ReadFrom>::read::<_, ()>(&mut buffered),
            Err(Error::Test)
        ));
        assert!(matches!(
            <OkBlock as crate::ReadBlockFrom>::read(&mut buffered, false),
            Err(Error::Test)
        ));
        assert!(matches!(
            <OkBlock as crate::ReadBlockFromSlice>::read_from_slice(&[], false),
            Err(Error::Test)
        ));

        assert!(matches!(
            <ErrBlock as TryReadFromBuffered>::try_read::<_, ()>(&mut buffered),
            Err(Error::Test)
        ));
        assert!(matches!(
            <ErrBlock as TryReadFrom>::try_read::<_, ()>(&mut stream),
            Err(Error::Test)
        ));
        assert!(matches!(
            <ErrBlock as crate::ReadFrom>::read::<_, ()>(&mut buffered),
            Err(Error::Test)
        ));
        assert!(matches!(
            <ErrBlock as crate::ReadBlockFrom>::read(&mut buffered, false),
            Err(Error::Test)
        ));
        assert!(matches!(
            <ErrBlock as crate::ReadBlockFromSlice>::read_from_slice(&[], false),
            Err(Error::Test)
        ));

        let mut local_payload = LocalPayload(vec![1, 2, 3]);
        assert!(matches!(
            <LocalPayload as TryExtractPayloadFromBuffered<LocalPayload>>::try_read(
                &mut buffered,
                &payload_header,
                &mut ()
            ),
            Err(Error::Test)
        ));
        assert!(matches!(
            <LocalPayload as TryExtractPayloadFrom<LocalPayload>>::try_read(
                &mut stream,
                &payload_header,
                &mut ()
            ),
            Err(Error::Test)
        ));
        assert!(matches!(
            <LocalPayload as ExtractPayloadFrom<LocalPayload>>::read(
                &mut buffered,
                &payload_header,
                &mut ()
            ),
            Err(Error::Test)
        ));
        assert_eq!(
            <LocalPayload as WriteMutTo>::write(&mut local_payload, &mut Vec::new(), &mut ())
                .expect("local payload write"),
            3
        );

        let mut owned_payload = OwnedPayload(vec![4, 5, 6]);
        assert!(matches!(
            <OwnedPayload as TryExtractPayloadFromBuffered<OwnedPayload>>::try_read(
                &mut buffered,
                &payload_header,
                &mut ()
            ),
            Err(Error::Test)
        ));
        assert!(matches!(
            <OwnedPayload as TryExtractPayloadFrom<OwnedPayload>>::try_read(
                &mut stream,
                &payload_header,
                &mut ()
            ),
            Err(Error::Test)
        ));
        assert!(matches!(
            <OwnedPayload as ExtractPayloadFrom<OwnedPayload>>::read(
                &mut buffered,
                &payload_header,
                &mut ()
            ),
            Err(Error::Test)
        ));
        assert_eq!(
            <OwnedPayload as WriteMutTo>::write(&mut owned_payload, &mut Vec::new(), &mut ())
                .expect("owned payload write"),
            3
        );
    }
}