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
243
244
245
246
247
248
249

use tinyklv::dec::ber as decber;
use tinyklv::dec::binary as decb;
use tinyklv::dec::string as decs;
use tinyklv::enc::binary as encb;
use tinyklv::prelude::*;

#[test]
/// Tests that `u8` errors on empty input.
fn u8_empty() {
    let mut input: &[u8] = &[];
    assert!(decb::u8(&mut input).is_err());
}

#[test]
/// Tests that `be_u16` errors on empty input.
fn be_u16_empty() {
    let mut input: &[u8] = &[];
    assert!(decb::be_u16(&mut input).is_err());
}

#[test]
/// Tests that `be_u32` errors on empty input.
fn be_u32_empty() {
    let mut input: &[u8] = &[];
    assert!(decb::be_u32(&mut input).is_err());
}

#[test]
/// Tests that `be_u64` errors on empty input.
fn be_u64_empty() {
    let mut input: &[u8] = &[];
    assert!(decb::be_u64(&mut input).is_err());
}

#[test]
/// Tests that `be_u128` errors on empty input.
fn be_u128_empty() {
    let mut input: &[u8] = &[];
    assert!(decb::be_u128(&mut input).is_err());
}

#[test]
/// Tests that `i8` errors on empty input.
fn i8_empty() {
    let mut input: &[u8] = &[];
    assert!(decb::i8(&mut input).is_err());
}

#[test]
/// Tests that `be_i16` errors on empty input.
fn be_i16_empty() {
    let mut input: &[u8] = &[];
    assert!(decb::be_i16(&mut input).is_err());
}

#[test]
/// Tests that `be_i32` errors on empty input.
fn be_i32_empty() {
    let mut input: &[u8] = &[];
    assert!(decb::be_i32(&mut input).is_err());
}

#[test]
/// Tests that `be_i64` errors on empty input.
fn be_i64_empty() {
    let mut input: &[u8] = &[];
    assert!(decb::be_i64(&mut input).is_err());
}

#[test]
/// Tests that `be_f32` errors on empty input.
fn be_f32_empty() {
    let mut input: &[u8] = &[];
    assert!(decb::be_f32(&mut input).is_err());
}

#[test]
/// Tests that `be_f64` errors on empty input.
fn be_f64_empty() {
    let mut input: &[u8] = &[];
    assert!(decb::be_f64(&mut input).is_err());
}

#[test]
/// Tests that `le_u16` errors on empty input.
fn le_u16_empty() {
    let mut input: &[u8] = &[];
    assert!(decb::le_u16(&mut input).is_err());
}

#[test]
/// Tests that `le_u32` errors on empty input.
fn le_u32_empty() {
    let mut input: &[u8] = &[];
    assert!(decb::le_u32(&mut input).is_err());
}

#[test]
/// Tests that `le_u64` errors on empty input.
fn le_u64_empty() {
    let mut input: &[u8] = &[];
    assert!(decb::le_u64(&mut input).is_err());
}

#[test]
/// Tests that `be_u16_lengthed(2)` errors when asked for 2 bytes from empty input.
fn be_u16_lengthed_empty_fails_on_positive_len() {
    let mut input: &[u8] = &[];
    assert!(decb::be_u16_lengthed(2)(&mut input).is_err());
}

#[test]
/// Tests that `be_u32_lengthed(4)` errors when asked for 4 bytes from empty input.
fn be_u32_lengthed_empty_fails() {
    let mut input: &[u8] = &[];
    assert!(decb::be_u32_lengthed(4)(&mut input).is_err());
}

#[test]
/// Tests that `ber_length` errors on empty input (no first byte to interpret).
fn ber_length_empty() {
    let mut input: &[u8] = &[];
    assert!(decber::ber_length(&mut input).is_err());
}

#[test]
/// Tests that `ber_oid::<u64>` errors on empty input.
fn ber_oid_empty() {
    let mut input: &[u8] = &[];
    assert!(decber::ber_oid::<u64>(&mut input).is_err());
}

#[test]
/// Tests that `to_string_utf8(0)` on empty input succeeds and returns an empty string.
fn to_string_utf8_empty_zero_len_ok() {
    // len=0 on empty slice is fine
    let mut input: &[u8] = &[];
    let result = decs::to_string_utf8(0)(&mut input);
    assert!(result.is_ok());
    assert_eq!(result.unwrap(), "");
}

#[test]
/// Tests that `to_string_utf8(1)` errors on empty input because one byte is required.
fn to_string_utf8_nonzero_len_on_empty_fails() {
    let mut input: &[u8] = &[];
    let result = decs::to_string_utf8(1)(&mut input);
    assert!(result.is_err());
}

#[test]
/// Tests that `to_string_utf16_le(0)` on empty input succeeds and returns an empty string.
fn to_string_utf16_le_zero_len_on_empty_ok() {
    // len=0 on empty input is valid - zero bytes consumed, empty string returned
    let mut input: &[u8] = &[];
    let result = decs::to_string_utf16_le(0)(&mut input);
    assert!(result.is_ok());
    assert_eq!(result.unwrap(), "");
}

#[test]
/// Tests that `to_string_utf16_le(2)` errors on empty input because two bytes are required.
fn to_string_utf16_le_nonzero_len_on_empty_fails() {
    let mut input: &[u8] = &[];
    let result = decs::to_string_utf16_le(2)(&mut input);
    assert!(result.is_err());
}

#[test]
/// Tests that `u8_as_usize` errors on empty input.
fn u8_as_usize_empty() {
    let mut input: &[u8] = &[];
    assert!(decb::u8_as_usize(&mut input).is_err());
}

#[test]
/// Tests that `be_u16_as_usize` errors on empty input.
fn be_u16_as_usize_empty() {
    let mut input: &[u8] = &[];
    assert!(decb::be_u16_as_usize(&mut input).is_err());
}

#[test]
/// Tests that `le_u16_as_usize` errors on empty input.
fn le_u16_as_usize_empty() {
    let mut input: &[u8] = &[];
    assert!(decb::le_u16_as_usize(&mut input).is_err());
}

#[derive(Klv, Debug, PartialEq)]
/// A struct with all required fields - must fail on empty input
#[klv(
    stream = &[u8],
    key(dec = decb::u8, enc = encb::u8),
    len(dec = decb::u8_as_usize, enc = encb::u8_from_usize),
)]
struct AllRequired {
    #[klv(
        key = 0x01,
        dec = decb::be_u16,
        enc = *encb::be_u16,
    )]
    val: u16,
}

#[test]
/// Tests that deriving `decode_value` on a struct with a required field errors when the input stream is empty.
fn derive_all_required_empty_input_fails() {
    let result = AllRequired::decode_value(&mut &[][..]);
    assert!(
        result.is_err(),
        "struct with required field must fail on empty input"
    );
}

#[derive(Klv, Debug, PartialEq)]
#[klv(
    stream = &[u8],
    key(dec = decb::u8, enc = encb::u8),
    len(dec = decb::u8_as_usize, enc = encb::u8_from_usize),
)]
/// A struct with only optional fields - must succeed (all None) on empty input
struct AllOptional {
    #[klv(
        key = 0x01,
        dec = decb::be_u16,
        enc = *encb::be_u16,
    )]
    val: Option<u16>,
    #[klv(
        key = 0x02,
        dec = decb::be_u32,
        enc = *encb::be_u32,
    )]
    other: Option<u32>,
}

#[test]
/// Tests that an all-optional struct decodes an empty stream successfully with every field set to `None`.
fn derive_all_optional_empty_input_ok_all_none() {
    let result = AllOptional::decode_value(&mut &[][..]);
    assert!(
        result.is_ok(),
        "struct with only optional fields must succeed on empty input"
    );
    let s = result.unwrap();
    assert_eq!(s.val, None);
    assert_eq!(s.other, None);
}