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
use std::fs::File;
use std::io::prelude::*;
pub const BUF_SIZE: usize = 512;
#[derive(Debug)]
pub enum BufferError {
IoError(std::io::Error),
ReadOverrun,
WriteOverrun,
}
impl From<std::io::Error> for BufferError {
fn from(err: std::io::Error) -> Self {
BufferError::IoError(err)
}
}
pub type Result<T> = std::result::Result<T, BufferError>;
pub trait Serialize {
type Buffer;
type Structure;
fn serialize(struc: Self::Structure, buf: &mut Self::Buffer) -> Result<()>;
}
pub trait Deserialize {
type Buffer;
type Structure;
fn deserialize(buf: &mut Self::Buffer) -> Result<Self::Structure>;
}
pub struct BytePacketBuffer {
pub buf: [u8; BUF_SIZE],
pos: usize,
}
impl BytePacketBuffer {
pub fn new() -> BytePacketBuffer {
BytePacketBuffer {
buf: [0; BUF_SIZE],
pos: 0,
}
}
pub fn fill_from_slice(&mut self, in_buf: &[u8]) {
if in_buf.len() < BUF_SIZE {
self.buf[..in_buf.len()].copy_from_slice(&in_buf);
} else {
self.buf.copy_from_slice(&in_buf[..BUF_SIZE]);
}
}
#[allow(clippy::unused_io_amount)]
pub fn fill_from_file(&mut self, path: &str) -> Result<()> {
let mut f = File::open(path)?;
f.read(&mut self.buf)?;
Ok(())
}
pub fn pos(&self) -> usize {
self.pos
}
pub fn step(&mut self, num_steps: usize) {
self.pos += num_steps;
}
pub fn seek(&mut self, new_pos: usize) {
self.pos = new_pos
}
pub fn peek(&self) -> Result<u8> {
if self.pos >= BUF_SIZE {
return Err(BufferError::ReadOverrun);
}
Ok(self.buf[self.pos])
}
pub fn peek_slice(&self, start: usize, len: usize) -> Result<&[u8]> {
if start + len >= BUF_SIZE {
return Err(BufferError::ReadOverrun);
}
Ok(&self.buf[start..start + len])
}
pub fn pop(&mut self) -> Result<u8> {
if self.pos >= BUF_SIZE {
return Err(BufferError::ReadOverrun);
}
let res = self.buf[self.pos];
self.pos += 1;
Ok(res)
}
pub fn pop_u16(&mut self) -> Result<u16> {
let res = ((self.pop()? as u16) << 8) | (self.pop()? as u16);
Ok(res)
}
pub fn pop_u32(&mut self) -> Result<u32> {
let res = ((self.pop()? as u32) << 24)
| ((self.pop()? as u32) << 16)
| ((self.pop()? as u32) << 8)
| (self.pop()? as u32);
Ok(res)
}
pub fn push(&mut self, data: u8) -> Result<()> {
if self.pos >= BUF_SIZE {
return Err(BufferError::WriteOverrun);
}
self.buf[self.pos] = data;
self.pos += 1;
Ok(())
}
pub fn push_slice(&mut self, data: &[u8]) -> Result<()> {
if self.pos + data.len() >= BUF_SIZE {
return Err(BufferError::WriteOverrun);
}
for b in data {
self.push(*b)?;
}
Ok(())
}
pub fn push_u16(&mut self, data: u16) -> Result<()> {
self.push(((data >> 8) & (0xFF)) as u8)?;
self.push((data & (0xFF)) as u8)?;
Ok(())
}
pub fn push_u32(&mut self, data: u32) -> Result<()> {
self.push(((data >> 24) & (0xFF)) as u8)?;
self.push(((data >> 16) & (0xFF)) as u8)?;
self.push(((data >> 8) & (0xFF)) as u8)?;
self.push((data & (0xFF)) as u8)?;
Ok(())
}
}
impl Default for BytePacketBuffer {
fn default() -> Self {
BytePacketBuffer::new()
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn fill_slice_smaller() {
let bin = b"supercooltest";
let mut buf = BytePacketBuffer::new();
buf.fill_from_slice(bin);
assert_eq!(bin[..], buf.buf[..bin.len()]);
}
#[test]
fn fill_slice_larger() {
let bin = [1u8; BUF_SIZE + 8];
let mut buf = BytePacketBuffer::new();
buf.fill_from_slice(&bin[..]);
assert_eq!(bin[..BUF_SIZE], buf.buf[..]);
}
#[test]
fn peek_init_happy() {
let bin = b"supercooltest";
let mut buf = BytePacketBuffer::new();
buf.fill_from_slice(bin);
assert_eq!(0, buf.pos());
assert_eq!(b"s"[0], buf.peek().unwrap());
}
#[test]
fn step_happy() {
let bin = b"supercooltest";
let mut buf = BytePacketBuffer::new();
buf.fill_from_slice(bin);
buf.step(5);
assert_eq!(5, buf.pos());
assert_eq!(b"c"[0], buf.peek().unwrap());
}
#[test]
fn step_err_buf_over() {
let mut buf = BytePacketBuffer::new();
buf.step(BUF_SIZE);
assert_eq!(BUF_SIZE, buf.pos());
let _err = buf.peek().err();
assert!(matches!(Some(BufferError::ReadOverrun), _err));
}
#[test]
fn seek_happy() {
let bin = b"supercooltest";
let mut buf = BytePacketBuffer::new();
buf.fill_from_slice(bin);
buf.seek(8);
assert_eq!(8, buf.pos());
buf.seek(2);
assert_eq!(2, buf.pos());
assert_eq!(b"p"[0], buf.peek().unwrap());
}
#[test]
fn seek_err_buf_over() {
let mut buf = BytePacketBuffer::new();
buf.seek(BUF_SIZE + 5);
assert_eq!(BUF_SIZE + 5, buf.pos());
let _err = buf.peek().err();
assert!(matches!(Some(BufferError::ReadOverrun), _err));
}
#[test]
fn peek_slice_happy() {
let bin = b"supercooltest";
let mut buf = BytePacketBuffer::new();
buf.fill_from_slice(bin);
assert_eq!(b"cool"[..], *buf.peek_slice(5, 4).unwrap());
}
#[test]
fn peek_slice_err_buf_over() {
let buf = BytePacketBuffer::new();
let _err = buf.peek_slice(BUF_SIZE - 5, 10).err();
assert!(matches!(Some(BufferError::ReadOverrun), _err));
}
#[test]
fn pop_happy() {
let bin = b"supercooltest";
let mut buf = BytePacketBuffer::new();
buf.fill_from_slice(bin);
assert_eq!(b"s"[0], buf.pop().unwrap());
buf.seek(5);
assert_eq!(b"c"[0], buf.pop().unwrap());
}
#[test]
fn pop_err_buf_over() {
let mut buf = BytePacketBuffer::new();
buf.seek(BUF_SIZE);
let _err = buf.pop().err();
assert!(matches!(Some(BufferError::ReadOverrun), _err));
}
#[test]
fn pop_u16_happy() {
let bin: [u8; 4] = [0x1F, 0xFA, 0xCC, 0x37];
let mut buf = BytePacketBuffer::new();
buf.fill_from_slice(&bin[..]);
assert_eq!(0x1FFA, buf.pop_u16().unwrap());
assert_eq!(0xCC37, buf.pop_u16().unwrap());
buf.seek(1);
assert_eq!(0xFACC, buf.pop_u16().unwrap());
}
#[test]
fn pop_u16_err_buf_over() {
let bin: [u8; BUF_SIZE] = [0xFF; BUF_SIZE];
let mut buf = BytePacketBuffer::new();
buf.fill_from_slice(&bin[..]);
buf.seek(BUF_SIZE - 1);
let _err = buf.pop_u16().err();
assert!(matches!(Some(BufferError::ReadOverrun), _err));
}
#[test]
fn pop_u32_happy() {
let bin: [u8; 8] = [0x1F, 0xFA, 0xCC, 0x37, 0x41, 0x1B, 0xFE, 0x12];
let mut buf = BytePacketBuffer::new();
buf.fill_from_slice(&bin[..]);
assert_eq!(0x1FFACC37, buf.pop_u32().unwrap());
assert_eq!(0x411BFE12, buf.pop_u32().unwrap());
buf.seek(2);
assert_eq!(0xCC37411B, buf.pop_u32().unwrap());
}
#[test]
fn pop_u32_err_buf_over() {
let bin: [u8; BUF_SIZE] = [0xFF; BUF_SIZE];
let mut buf = BytePacketBuffer::new();
buf.fill_from_slice(&bin[..]);
buf.seek(BUF_SIZE - 3);
let _err = buf.pop_u32().err();
assert!(matches!(Some(BufferError::ReadOverrun), _err));
}
}