tinyklv 0.1.0

The simplest Key-Length-Value (KLV) framework in 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

#[test]
/// Tests `be_u16_lengthed(2)` decodes an exact 2-byte big-endian u16.
fn be_u16_lengthed_exact() {
    let mut input: &[u8] = &[0x01, 0xE0];
    assert_eq!(
        tinyklv::dec::binary::be_u16_lengthed(2)(&mut input),
        Ok(0x01E0_u16)
    );
}

#[test]
/// Tests `be_u16_lengthed(4)` takes the last 2 of 4 consumed bytes when length exceeds the native width.
fn be_u16_lengthed_truncate() {
    // len=4 > native 2 bytes: takes last 2 of the 4 consumed bytes
    let mut input1: &[u8] = &[0x01, 0xE0, 0xFF, 0xFF];
    assert_eq!(
        tinyklv::dec::binary::be_u16_lengthed(4)(&mut input1),
        Ok(0xFFFF_u16)
    );
}

#[test]
/// Tests `be_u16_lengthed(1)` zero-pads the high byte when length is smaller than the native width.
fn be_u16_lengthed_pad() {
    // len=1 < native 2 bytes: zero-pads the high byte
    let mut input: &[u8] = &[0xE0];
    assert_eq!(
        tinyklv::dec::binary::be_u16_lengthed(1)(&mut input),
        Ok(0x00E0_u16)
    );
}

#[test]
/// Tests the canonical doctest examples for `be_u16_lengthed` across 4/2/1-byte inputs.
fn be_u16_lengthed_doctest() {
    let mut input1: &[u8] = &[0x01, 0xE0, 0xFF, 0xFF];
    let mut input2: &[u8] = &[0x01, 0xE0];
    let mut input3: &[u8] = &[0xE0];
    assert_eq!(
        tinyklv::dec::binary::be_u16_lengthed(4)(&mut input1),
        Ok(0xFFFF)
    );
    assert_eq!(
        tinyklv::dec::binary::be_u16_lengthed(2)(&mut input2),
        Ok(0x01E0)
    );
    assert_eq!(
        tinyklv::dec::binary::be_u16_lengthed(1)(&mut input3),
        Ok(0x00E0)
    );
}

#[test]
/// Tests `be_u32_lengthed(4)` decodes an exact 4-byte big-endian u32.
fn be_u32_lengthed_exact() {
    let mut input: &[u8] = &[0x00, 0x01, 0xE0, 0xFF];
    assert_eq!(
        tinyklv::dec::binary::be_u32_lengthed(4)(&mut input),
        Ok(0x0001E0FF_u32)
    );
}

#[test]
/// Tests `be_u32_lengthed(5)` takes the last 4 of 5 consumed bytes.
fn be_u32_lengthed_truncate() {
    // len=5: takes last 4 of the 5 consumed bytes
    let mut input: &[u8] = &[0x00, 0x01, 0xE0, 0xFF, 0xFF];
    assert_eq!(
        tinyklv::dec::binary::be_u32_lengthed(5)(&mut input),
        Ok(0x01E0FFFF_u32)
    );
}

#[test]
/// Tests `be_u32_lengthed(3)` zero-pads the high byte of a u32.
fn be_u32_lengthed_pad() {
    // len=3: zero-pads high byte
    let mut input: &[u8] = &[0x01, 0xE0, 0xFF];
    assert_eq!(
        tinyklv::dec::binary::be_u32_lengthed(3)(&mut input),
        Ok(0x0001E0FF_u32)
    );
}

#[test]
/// Tests `be_u64_lengthed(8)` decodes an exact 8-byte big-endian u64.
fn be_u64_lengthed_exact() {
    let val: u64 = 0x0001020304050607;
    let bytes = val.to_be_bytes();
    let mut input: &[u8] = &bytes;
    assert_eq!(
        tinyklv::dec::binary::be_u64_lengthed(8)(&mut input),
        Ok(val)
    );
}

#[test]
/// Tests `be_u64_lengthed(9)` takes the last 8 of 9 consumed bytes.
fn be_u64_lengthed_truncate() {
    // len=9: last 8 bytes
    let mut input: &[u8] = &[0x00, 0x00, 0x01, 0xE0, 0xFF, 0xFF, 0x00, 0x00, 0x00];
    assert_eq!(
        tinyklv::dec::binary::be_u64_lengthed(9)(&mut input),
        Ok(0x00_01_E0_FF_FF_00_00_00_u64)
    );
}

#[test]
/// Tests `be_u64_lengthed(1)` zero-pads 7 high bytes for a single-byte input.
fn be_u64_lengthed_pad() {
    // len=1: zero-pads 7 high bytes
    let mut input: &[u8] = &[0xAB];
    assert_eq!(
        tinyklv::dec::binary::be_u64_lengthed(1)(&mut input),
        Ok(0x00_00_00_00_00_00_00_AB_u64)
    );
}

#[test]
/// Tests `le_u16_lengthed(2)` decodes an exact 2-byte little-endian u16.
fn le_u16_lengthed_exact() {
    let mut input: &[u8] = &[0xE0, 0x01];
    assert_eq!(
        tinyklv::dec::binary::le_u16_lengthed(2)(&mut input),
        Ok(0x01E0_u16)
    );
}

#[test]
/// Tests `le_u16_lengthed(5)` uses the first 2 bytes in LE ordering when length exceeds native width.
fn le_u16_lengthed_truncate() {
    // len=5: takes first 2 bytes in LE
    let mut input: &[u8] = &[0xE0, 0x01, 0xFF, 0xFF, 0xFF];
    assert_eq!(
        tinyklv::dec::binary::le_u16_lengthed(5)(&mut input),
        Ok(480_u16) // 0x01E0 = 480
    );
}

#[test]
/// Tests `le_u16_lengthed(1)` zero-pads the high byte of a u16.
fn le_u16_lengthed_pad() {
    // len=1: zero-pads high byte
    let mut input: &[u8] = &[0x01];
    assert_eq!(
        tinyklv::dec::binary::le_u16_lengthed(1)(&mut input),
        Ok(1_u16)
    );
}

#[test]
/// Tests `le_u32_lengthed(3)` decodes 3 little-endian bytes into a u32 with high byte zero-padded.
fn le_u32_lengthed_exact() {
    let mut full_input: &[u8] = &[0x01, 0x02, 0x03];
    assert_eq!(
        tinyklv::dec::binary::le_u32_lengthed(3)(&mut full_input),
        Ok(197_121_u32)
    );
}

#[test]
/// Tests `le_u32_lengthed(5)` uses the first 4 LE bytes when length exceeds native width.
fn le_u32_lengthed_truncate() {
    // len=5: takes first 4 bytes in LE
    let mut input: &[u8] = &[0xE0, 0x01, 0xFF, 0xFF, 0xFF];
    assert_eq!(
        tinyklv::dec::binary::le_u32_lengthed(5)(&mut input),
        Ok(4_294_902_240_u32)
    );
}

#[test]
/// Tests `le_u32_lengthed(1)` decodes a single byte into the low byte of a u32.
fn le_u32_lengthed_single_byte() {
    let mut input: &[u8] = &[0x01];
    assert_eq!(
        tinyklv::dec::binary::le_u32_lengthed(1)(&mut input),
        Ok(1_u32)
    );
}

#[test]
/// Tests that `enc::be_u32_lengthed(4)` emits all 4 big-endian bytes of a u32.
fn enc_be_u32_lengthed_exact() {
    assert_eq!(
        tinyklv::enc::binary::be_u32_lengthed(4)(0x0001E0FF_u32),
        vec![0x00, 0x01, 0xE0, 0xFF]
    );
}

#[test]
/// Tests that `enc::be_u32_lengthed(3)` strips the high zero byte from a u32 encoding.
fn enc_be_u32_lengthed_truncate() {
    // len=3: strips high byte 0x00
    assert_eq!(
        tinyklv::enc::binary::be_u32_lengthed(3)(0x0001E0FF_u32),
        vec![0x01, 0xE0, 0xFF]
    );
}

#[test]
/// Tests that `enc::be_u32_lengthed(5)` zero-pads a u32 encoding on the left.
fn enc_be_u32_lengthed_pad() {
    // len=5: zero-pads left
    assert_eq!(
        tinyklv::enc::binary::be_u32_lengthed(5)(0x01E0FFFF_u32),
        vec![0x00, 0x01, 0xE0, 0xFF, 0xFF]
    );
}

#[test]
/// Tests that `enc::le_u16_lengthed(5)` starts with the 2 LE bytes of the value.
fn enc_le_u16_lengthed_truncate() {
    // len=5 but u16 is 2 bytes: result is 2 LE bytes + 3 zero-pads
    let result = tinyklv::enc::binary::le_u16_lengthed(5)(480_u16);
    assert_eq!(&result[..2], &[0xE0, 0x01]);
}

#[test]
/// Tests that `enc::le_u16_lengthed(1)` emits a single byte for a u16 value that fits in one byte.
fn enc_le_u16_lengthed_single_byte() {
    let result = tinyklv::enc::binary::le_u16_lengthed(1)(1_u16);
    assert_eq!(&result[..1], &[0x01]);
}

#[test]
/// Tests `be_u16_lengthed(0)` decodes to `0` without consuming input.
fn be_u16_lengthed_zero_len() {
    // consuming 0 bytes should decode to 0
    let mut input: &[u8] = &[0xAB, 0xCD];
    assert_eq!(
        tinyklv::dec::binary::be_u16_lengthed(0)(&mut input),
        Ok(0_u16)
    );
}

#[test]
/// Tests `enc::be_u16_lengthed(0)` produces an empty byte vector.
fn enc_be_u16_lengthed_zero_len() {
    let result = tinyklv::enc::binary::be_u16_lengthed(0)(0x1234_u16);
    assert!(result.is_empty());
}