brec 0.2.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

use crate::*;

pub struct TestBlock {
    #[allow(dead_code)]
    field: u8,
}

impl Size for TestBlock {
    fn size(&self) -> u64 {
        0
    }
}

impl WriteVectoredTo for TestBlock {
    fn slices(&self) -> std::io::Result<IoSlices<'_>> {
        Err(std::io::Error::other("test"))
    }
}

impl WriteTo for TestBlock {
    fn write<T: std::io::Write>(&self, _: &mut T) -> std::io::Result<usize> {
        Err(std::io::Error::other("test"))
    }
    fn write_all<T: std::io::Write>(&self, _: &mut T) -> std::io::Result<()> {
        Err(std::io::Error::other("test"))
    }
}

impl TryReadFromBuffered for TestBlock {
    fn try_read<T: std::io::BufRead>(_: &mut T) -> Result<ReadStatus<Self>, Error>
    where
        Self: Sized,
    {
        Err(Error::Test)
    }
}

impl TryReadFrom for TestBlock {
    fn try_read<T: std::io::Read + std::io::Seek>(_: &mut T) -> Result<ReadStatus<Self>, Error>
    where
        Self: Sized,
    {
        Err(Error::Test)
    }
}

impl ReadFrom for TestBlock {
    fn read<T: std::io::Read>(_: &mut T) -> Result<Self, Error>
    where
        Self: Sized,
    {
        Err(Error::Test)
    }
}

impl ReadBlockFrom for TestBlock {
    fn read<T: std::io::Read>(_: &mut T, _: bool) -> Result<Self, Error>
    where
        Self: Sized,
    {
        Err(Error::Test)
    }
}

impl ReadBlockFromSlice for TestBlock {
    fn read_from_slice<'a>(_: &'a [u8], _: bool) -> Result<Self, Error>
    where
        Self: 'a + Sized,
    {
        Err(Error::Test)
    }
}

impl BlockDef for TestBlock {}

impl BlockReferredDef<TestBlock> for TestBlock {}

pub struct TestPayload {
    #[allow(dead_code)]
    field: u8,
}

impl WriteVectoredMutTo for TestPayload {
    fn slices(&mut self) -> std::io::Result<IoSlices<'_>> {
        Err(std::io::Error::other("test"))
    }
}

impl WriteMutTo for TestPayload {
    fn write<T: std::io::Write>(&mut self, _: &mut T) -> std::io::Result<usize> {
        Err(std::io::Error::other("test"))
    }
    fn write_all<T: std::io::Write>(&mut self, _: &mut T) -> std::io::Result<()> {
        Err(std::io::Error::other("test"))
    }
}

impl PayloadSignature for TestPayload {
    fn sig(&self) -> ByteBlock {
        ByteBlock::Len4([0, 0, 0, 0])
    }
}

impl PayloadEncodeReferred for TestPayload {
    fn encode(&self) -> std::io::Result<Option<&[u8]>> {
        Err(std::io::Error::other("test"))
    }
}

impl PayloadHooks for TestPayload {
    fn after_decode(&mut self) -> std::io::Result<()> {
        Err(std::io::Error::other("test"))
    }
    fn before_encode(&mut self) -> std::io::Result<()> {
        Err(std::io::Error::other("test"))
    }
}

impl PayloadEncode for TestPayload {
    fn encode(&self) -> std::io::Result<Vec<u8>> {
        Err(std::io::Error::other("test"))
    }
}

impl PayloadCrc for TestPayload {
    fn crc(&self) -> std::io::Result<ByteBlock> {
        Err(std::io::Error::other("test"))
    }
    fn crc_size() -> usize {
        0
    }
}

impl PayloadSize for TestPayload {
    fn size(&self) -> std::io::Result<u64> {
        Err(std::io::Error::other("test"))
    }
}
impl PayloadInnerDef for TestPayload {}

impl TryExtractPayloadFromBuffered<TestPayload> for TestPayload {
    fn try_read<B: std::io::BufRead>(
        _: &mut B,
        _: &PayloadHeader,
    ) -> Result<ReadStatus<TestPayload>, Error> {
        Err(Error::Test)
    }
}

impl TryExtractPayloadFrom<TestPayload> for TestPayload {
    fn try_read<B: std::io::Read + std::io::Seek>(
        _: &mut B,
        _: &PayloadHeader,
    ) -> Result<ReadStatus<TestPayload>, Error> {
        Err(Error::Test)
    }
}

impl ExtractPayloadFrom<TestPayload> for TestPayload {
    fn read<B: std::io::Read>(_: &mut B, _: &PayloadHeader) -> Result<TestPayload, Error> {
        Err(Error::Test)
    }
}

impl PayloadDef<TestPayload> for TestPayload {}