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
use crate::*;
#[cfg(feature = "resilient")]
use brec_consts::{BLOCK_CRC_LEN, BLOCK_SIG_LEN, BLOCK_SIZE_FIELD_LEN};

/// Reads a complete `PacketDef` from a stream, including header, blocks, and optional payload.
///
/// This implementation **does not support partial reads** - if the header is successfully
/// read but the blocks or payload data are incomplete, an I/O error will be returned.
///
/// # Notes
/// - Does **not** return `Error::NotEnoughData`; instead, read failures always result in `std::io::Error`.
/// - Use this implementation when you're sure the entire packet is available in the stream.
///
/// # Errors
/// - `Error::SignatureDismatch` or `Error::CrcDismatch` if header validation fails.
/// - `Error::NotEnoughData` if there’s insufficient data in the inner block stream.
/// - `Error::MaxBlocksCount` if the block count exceeds the allowed maximum.
/// - Any decoding or payload-related error from underlying implementations.
impl<B: BlockDef, P: PayloadDef<Inner>, Inner: PayloadInnerDef> ReadPacketFrom
    for PacketDef<B, P, Inner>
{
    fn read<T: std::io::Read>(
        buf: &mut T,
        ctx: &mut <Self as ProtocolSchema>::Context<'_>,
    ) -> Result<Self, Error>
    where
        Self: Sized,
    {
        let header = PacketHeader::read::<_, Inner>(buf)?;
        let mut pkg = PacketDef::default();
        let mut read = 0;
        if header.blocks_len > 0 {
            let mut blocks = vec![0u8; header.blocks_len as usize];
            buf.read_exact(&mut blocks)?;
            let mut reader = std::io::Cursor::new(blocks);
            let mut iterations = 0;
            loop {
                match <B as TryReadFromBuffered>::try_read::<_, Inner>(&mut reader)? {
                    ReadStatus::Success(blk) => {
                        read += blk.size();
                        pkg.blocks.push(blk);
                        if read == header.blocks_len {
                            break;
                        }
                    }
                    ReadStatus::NotEnoughData(needed) => {
                        return Err(Error::NotEnoughData(needed as usize));
                    }
                }
                iterations += 1;
                if iterations > MAX_BLOCKS_COUNT as usize {
                    return Err(Error::MaxBlocksCount);
                }
            }
        }
        if header.payload {
            let payload_header = <PayloadHeader as ReadFrom>::read::<_, Inner>(buf)?;
            header.validate_payload(&payload_header)?;
            let payload = <P as ExtractPayloadFrom<Inner>>::read(buf, &payload_header, ctx)?;
            pkg.payload = Some(payload);
        }
        Ok(pkg)
    }
}

/// Attempts to read a `PacketDef` from a seekable stream with partial read awareness.
///
/// This implementation checks if enough data is available before attempting to decode,
/// and can return `ReadStatus::NotEnoughData(...)` instead of failing with an I/O error.
///
/// # Behavior
/// - If not enough data is available for the entire payload, stream position is reset.
/// - If read fails partway through (block or payload), stream position is reset and the error returned.
/// - If block count exceeds `MAX_BLOCKS_COUNT`, returns `Error::MaxBlocksCount`.
///
/// # Returns
/// - `PacketReadStatus::Success(packet)` - full packet successfully read.
/// - `PacketReadStatus::NotEnoughData(bytes)` - more data needed to complete the packet.
/// - `Error` - on decoding, CRC, signature, or logic errors.
///
/// # Stream behavior
/// Seeks forward to read the packet, and seeks back on early return or error.
impl<B: BlockDef, P: PayloadDef<Inner>, Inner: PayloadInnerDef> TryReadPacketFrom
    for PacketDef<B, P, Inner>
{
    fn try_read<T: std::io::Read + std::io::Seek>(
        buf: &mut T,
        ctx: &mut <Self as ProtocolSchema>::Context<'_>,
    ) -> Result<PacketReadStatus<Self>, Error>
    where
        Self: Sized,
    {
        let start_pos = buf.stream_position()?;
        let available = buf.seek(std::io::SeekFrom::End(0))? - start_pos;
        buf.seek(std::io::SeekFrom::Start(start_pos))?;
        #[cfg(feature = "resilient")]
        let mut unrecognized = Vec::new();
        let packet_header = match <PacketHeader as TryReadFrom>::try_read::<_, Inner>(buf)? {
            ReadStatus::NotEnoughData(needed) => {
                return Ok(PacketReadStatus::NotEnoughData(needed));
            }
            ReadStatus::Success(header) => header,
        };
        let packet_size = PacketHeader::ssize() + packet_header.size;
        if packet_size > available {
            return Ok(PacketReadStatus::NotEnoughData(packet_size - available));
        }
        let mut pkg = PacketDef::default();
        let mut read = 0;
        if packet_header.blocks_len > 0 {
            let mut iterations = 0;
            loop {
                match <B as TryReadFrom>::try_read::<_, Inner>(buf) {
                    Ok(ReadStatus::Success(blk)) => {
                        read += blk.size();
                        pkg.blocks.push(blk);
                        if read == packet_header.blocks_len {
                            break;
                        }
                    }
                    Ok(ReadStatus::NotEnoughData(needed)) => {
                        buf.seek(std::io::SeekFrom::Start(start_pos))?;
                        return Ok(PacketReadStatus::NotEnoughData(needed));
                    }
                    Err(err) => {
                        #[cfg(feature = "resilient")]
                        if let Error::SignatureDismatch(mut entry) = err {
                            let Some(body_len) = entry.len else {
                                buf.seek(std::io::SeekFrom::Start(start_pos))?;
                                return Err(Error::ZeroLengthBlock);
                            };
                            if body_len == 0 {
                                buf.seek(std::io::SeekFrom::Start(start_pos))?;
                                return Err(Error::InvalidLength);
                            }
                            let block_len = BLOCK_SIG_LEN as u64
                                + BLOCK_SIZE_FIELD_LEN as u64
                                + body_len
                                + BLOCK_CRC_LEN as u64;
                            let blocks_left = packet_header.blocks_len.saturating_sub(read);
                            if block_len > blocks_left {
                                buf.seek(std::io::SeekFrom::Start(start_pos))?;
                                return Err(Error::InvalidLength);
                            }
                            entry.pos = Some(PacketHeader::ssize() + read);
                            buf.seek(std::io::SeekFrom::Current(block_len as i64))?;
                            read += block_len;
                            unrecognized.push(entry);
                            if read == packet_header.blocks_len {
                                break;
                            }
                            iterations += 1;
                            if iterations > MAX_BLOCKS_COUNT as usize {
                                buf.seek(std::io::SeekFrom::Start(start_pos))?;
                                return Err(Error::MaxBlocksCount);
                            }
                            continue;
                        }
                        buf.seek(std::io::SeekFrom::Start(start_pos))?;
                        return Err(err);
                    }
                }
                iterations += 1;
                if iterations > MAX_BLOCKS_COUNT as usize {
                    buf.seek(std::io::SeekFrom::Start(start_pos))?;
                    return Err(Error::MaxBlocksCount);
                }
            }
        }
        if packet_header.payload {
            match <PayloadHeader as TryReadFrom>::try_read::<_, Inner>(buf)? {
                ReadStatus::Success(payload_header) => {
                    if let Err(err) = packet_header.validate_payload(&payload_header) {
                        buf.seek(std::io::SeekFrom::Start(start_pos))?;
                        return Err(err);
                    }
                    match <P as TryExtractPayloadFrom<Inner>>::try_read(buf, &payload_header, ctx) {
                        Ok(ReadStatus::Success(payload)) => {
                            pkg.payload = Some(payload);
                        }
                        Ok(ReadStatus::NotEnoughData(needed)) => {
                            buf.seek(std::io::SeekFrom::Start(start_pos))?;
                            return Ok(PacketReadStatus::NotEnoughData(needed));
                        }
                        Err(err) => {
                            #[cfg(feature = "resilient")]
                            if let Error::SignatureDismatch(mut entry) = err {
                                let payload_len = payload_header.payload_len() as u64;
                                entry.pos =
                                    Some(PacketHeader::ssize() + packet_header.blocks_len + 1);
                                entry.len = Some(payload_len);
                                buf.seek(std::io::SeekFrom::Current(payload_len as i64))?;
                                unrecognized.push(entry);
                            } else {
                                buf.seek(std::io::SeekFrom::Start(start_pos))?;
                                return Err(err);
                            }
                            #[cfg(not(feature = "resilient"))]
                            {
                                buf.seek(std::io::SeekFrom::Start(start_pos))?;
                                return Err(err);
                            }
                        }
                    }
                }
                ReadStatus::NotEnoughData(needed) => {
                    buf.seek(std::io::SeekFrom::Start(start_pos))?;
                    return Err(Error::NotEnoughData(needed as usize));
                }
            }
        }
        #[cfg(feature = "resilient")]
        {
            Ok(PacketReadStatus::success(pkg, unrecognized))
        }
        #[cfg(not(feature = "resilient"))]
        {
            Ok(PacketReadStatus::success(pkg))
        }
    }
}

/// Attempts to read a `PacketDef` from a buffered reader.
///
/// This is similar to `TryReadFrom`, but works with non-seekable buffered sources (e.g., network streams).
///
/// # Behavior
/// - Reads header directly from `BufRead::fill_buf()` and consumes it.
/// - Ensures that `header.size` bytes are available before decoding.
/// - Supports partial reads using `ReadStatus::NotEnoughData(...)`.
///
/// # Returns
/// - `PacketReadStatus::Success(packet)` - if all required data was read and validated.
/// - `PacketReadStatus::NotEnoughData(bytes)` - if more bytes are needed.
/// - `Error::MaxBlocksCount` - if the block limit is exceeded.
/// - Any decoding or CRC/signature errors.
///
/// # Notes
/// The header and block stream are parsed directly from the internal buffer. Payload data may be buffered or streamed depending on implementation.
impl<B: BlockDef, P: PayloadDef<Inner>, Inner: PayloadInnerDef> TryReadPacketFromBuffered
    for PacketDef<B, P, Inner>
{
    fn try_read<T: std::io::BufRead>(
        reader: &mut T,
        ctx: &mut <Self as ProtocolSchema>::Context<'_>,
    ) -> Result<PacketReadStatus<Self>, Error>
    where
        Self: Sized,
    {
        let bytes = reader.fill_buf()?;
        let available = bytes.len() as u64;
        if available < PacketHeader::ssize() {
            return Ok(PacketReadStatus::NotEnoughData(
                PacketHeader::ssize() - available,
            ));
        }
        let packet_header = PacketHeader::read_from_slice(bytes, false)?;
        if packet_header.size > Inner::MAX_PACKET_LEN {
            return Err(Error::InvalidLength);
        }
        let packet_size = PacketHeader::ssize() + packet_header.size;
        if packet_size > available {
            return Ok(PacketReadStatus::NotEnoughData(packet_size - available));
        }
        reader.consume(PacketHeader::ssize() as usize);
        #[cfg(feature = "resilient")]
        let mut unrecognized = Vec::new();
        let mut pkg = PacketDef::default();
        let mut read = 0;
        if packet_header.blocks_len > 0 {
            let mut iterations = 0;
            loop {
                match <B as TryReadFromBuffered>::try_read::<_, Inner>(reader) {
                    Ok(ReadStatus::Success(blk)) => {
                        read += blk.size();
                        pkg.blocks.push(blk);
                        if read == packet_header.blocks_len {
                            break;
                        }
                    }
                    Ok(ReadStatus::NotEnoughData(needed)) => {
                        return Ok(PacketReadStatus::NotEnoughData(needed));
                    }
                    Err(err) => {
                        #[cfg(feature = "resilient")]
                        if let Error::SignatureDismatch(mut entry) = err {
                            let Some(body_len) = entry.len else {
                                return Err(Error::ZeroLengthBlock);
                            };
                            if body_len == 0 {
                                return Err(Error::InvalidLength);
                            }
                            let block_len = BLOCK_SIG_LEN as u64
                                + BLOCK_SIZE_FIELD_LEN as u64
                                + body_len
                                + BLOCK_CRC_LEN as u64;
                            let blocks_left = packet_header.blocks_len.saturating_sub(read);
                            if block_len > blocks_left {
                                return Err(Error::InvalidLength);
                            }
                            entry.pos = Some(PacketHeader::ssize() + read);
                            reader.consume(block_len as usize);
                            read += block_len;
                            unrecognized.push(entry);
                            if read == packet_header.blocks_len {
                                break;
                            }
                            iterations += 1;
                            if iterations > MAX_BLOCKS_COUNT as usize {
                                return Err(Error::MaxBlocksCount);
                            }
                            continue;
                        }
                        return Err(err);
                    }
                }
                iterations += 1;
                if iterations > MAX_BLOCKS_COUNT as usize {
                    return Err(Error::MaxBlocksCount);
                }
            }
        }
        if packet_header.payload {
            match <PayloadHeader as TryReadFromBuffered>::try_read::<_, Inner>(reader)? {
                ReadStatus::Success(payload_header) => {
                    packet_header.validate_payload(&payload_header)?;
                    reader.consume(payload_header.size());
                    match <P as TryExtractPayloadFromBuffered<Inner>>::try_read(
                        reader,
                        &payload_header,
                        ctx,
                    ) {
                        Ok(ReadStatus::Success(payload)) => {
                            pkg.payload = Some(payload);
                        }
                        Ok(ReadStatus::NotEnoughData(needed)) => {
                            return Ok(PacketReadStatus::NotEnoughData(needed));
                        }
                        Err(err) => {
                            #[cfg(feature = "resilient")]
                            if let Error::SignatureDismatch(mut entry) = err {
                                let payload_len = payload_header.payload_len() as u64;
                                entry.pos =
                                    Some(PacketHeader::ssize() + packet_header.blocks_len + 1);
                                entry.len = Some(payload_len);
                                reader.consume(payload_len as usize);
                                unrecognized.push(entry);
                            } else {
                                return Err(err);
                            }
                            #[cfg(not(feature = "resilient"))]
                            return Err(err);
                        }
                    }
                }
                ReadStatus::NotEnoughData(needed) => {
                    return Err(Error::NotEnoughData(needed as usize));
                }
            }
        }
        #[cfg(feature = "resilient")]
        {
            Ok(PacketReadStatus::success(pkg, unrecognized))
        }
        #[cfg(not(feature = "resilient"))]
        {
            Ok(PacketReadStatus::success(pkg))
        }
    }
}

#[cfg(test)]
mod tests {
    use crate::{
        ByteBlock, DefaultProtocolContext, Error, PacketDef, PacketHeader, PacketReadStatus,
        PayloadHeader, ProtocolSchema, ReadPacketFrom, TryReadPacketFrom,
        TryReadPacketFromBuffered, WriteTo,
        tests::{TestBlock, TestPayload},
    };
    use std::io::{BufReader, Cursor, Seek};

    fn empty_packet_bytes() -> Vec<u8> {
        let header = PacketHeader::from_lengths(0, 0, false);
        let mut out = Vec::new();
        header.write_all(&mut out).expect("packet header write");
        out
    }

    #[test]
    fn packet_read_and_try_read_and_buffered_succeed_for_empty_packet() {
        let bytes = empty_packet_bytes();

        let mut cursor = Cursor::new(bytes.clone());
        let packet = <PacketDef<TestBlock, TestPayload, TestPayload> as ReadPacketFrom>::read(
            &mut cursor,
            &mut DefaultProtocolContext::default(),
        )
        .expect("read empty packet");
        assert!(packet.blocks.is_empty());
        assert!(packet.payload.is_none());

        let mut cursor = Cursor::new(bytes.clone());
        match <PacketDef<TestBlock, TestPayload, TestPayload> as TryReadPacketFrom>::try_read(
            &mut cursor,
            &mut DefaultProtocolContext::default(),
        )
        .expect("try_read empty packet")
        {
            PacketReadStatus::Success(packet) => {
                #[cfg(feature = "resilient")]
                let packet = &packet.0;
                #[cfg(not(feature = "resilient"))]
                let packet = &packet;

                assert!(packet.blocks.is_empty());
                assert!(packet.payload.is_none());
            }
            PacketReadStatus::NotEnoughData(_) => panic!("expected Success"),
        }
        assert_eq!(
            cursor.stream_position().expect("stream_position"),
            PacketHeader::SIZE
        );

        let mut reader = BufReader::new(Cursor::new(bytes));
        match <PacketDef<TestBlock, TestPayload, TestPayload> as TryReadPacketFromBuffered>::try_read(
            &mut reader,
            &mut DefaultProtocolContext::default(),
        )
        .expect("buffered try_read empty packet")
        {
            PacketReadStatus::Success(packet) => {
                #[cfg(feature = "resilient")]
                let packet = &packet.0;
                #[cfg(not(feature = "resilient"))]
                let packet = &packet;

                assert!(packet.blocks.is_empty());
                assert!(packet.payload.is_none());
            }
            PacketReadStatus::NotEnoughData(_) => panic!("expected Success"),
        }
    }

    #[test]
    fn packet_try_read_and_buffered_report_not_enough_for_short_header() {
        let short = vec![1_u8, 2, 3];

        let mut cursor = Cursor::new(short.clone());
        match <PacketDef<TestBlock, TestPayload, TestPayload> as TryReadPacketFrom>::try_read(
            &mut cursor,
            &mut DefaultProtocolContext::default(),
        )
        .expect("try_read short must not fail")
        {
            PacketReadStatus::NotEnoughData(needed) => assert!(needed > 0),
            PacketReadStatus::Success(_) => panic!("expected NotEnoughData"),
        }
        assert_eq!(cursor.stream_position().expect("stream_position"), 0);

        let mut reader = BufReader::new(Cursor::new(short));
        match <PacketDef<TestBlock, TestPayload, TestPayload> as TryReadPacketFromBuffered>::try_read(
            &mut reader,
            &mut DefaultProtocolContext::default(),
        )
        .expect("buffered try_read short must not fail")
        {
            PacketReadStatus::NotEnoughData(needed) => assert!(needed > 0),
            PacketReadStatus::Success(_) => panic!("expected NotEnoughData"),
        }
    }

    #[test]
    fn packet_try_read_and_buffered_detect_invalid_payload_length_mismatch() {
        let payload_header = PayloadHeader {
            sig: ByteBlock::Len4(*b"ABCD"),
            crc: ByteBlock::Len4([1, 2, 3, 4]),
            len: 1,
        };
        let packet_header = PacketHeader::from_lengths(0, payload_header.size() as u64, true);

        let mut bytes = Vec::new();
        packet_header
            .write_all(&mut bytes)
            .expect("packet header write");
        bytes.extend_from_slice(&payload_header.as_vec());

        let mut cursor = Cursor::new(bytes.clone());
        assert!(matches!(
            <PacketDef<TestBlock, TestPayload, TestPayload> as ReadPacketFrom>::read(
                &mut cursor,
                &mut DefaultProtocolContext::default(),
            ),
            Err(Error::InvalidLength)
        ));

        let mut cursor = Cursor::new(bytes.clone());
        assert!(matches!(
            <PacketDef<TestBlock, TestPayload, TestPayload> as TryReadPacketFrom>::try_read(
                &mut cursor,
                &mut DefaultProtocolContext::default(),
            ),
            Err(Error::InvalidLength)
        ));
        assert_eq!(
            cursor.stream_position().expect("stream_position"),
            0,
            "seekable try_read should reset position on error"
        );

        let mut reader = BufReader::new(Cursor::new(bytes));
        assert!(matches!(
            <PacketDef<TestBlock, TestPayload, TestPayload> as TryReadPacketFromBuffered>::try_read(
                &mut reader,
                &mut DefaultProtocolContext::default(),
            ),
            Err(Error::InvalidLength)
        ));
    }

    #[test]
    fn packet_try_read_buffered_rejects_packet_size_larger_than_schema_max() {
        let packet_header = PacketHeader::from_lengths(TestPayload::MAX_PACKET_LEN + 1, 0, false);
        let mut bytes = Vec::new();
        packet_header
            .write_all(&mut bytes)
            .expect("packet header write");

        let mut reader = BufReader::new(Cursor::new(bytes));
        assert!(matches!(
            <PacketDef<TestBlock, TestPayload, TestPayload> as TryReadPacketFromBuffered>::try_read(
                &mut reader,
                &mut DefaultProtocolContext::default(),
            ),
            Err(Error::InvalidLength)
        ));
    }
}