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
use bitvec::{
vec::BitVec, store::BitStore, order::BitOrder, slice::BitSlice, boxed::BitBox, mem::BitMemory
};
use crate::{
EncodeLike, Encode, Decode, Input, Output, Error, Compact,
codec::{decode_vec_with_len, encode_slice_no_len},
};
impl<O: BitOrder, T: BitStore + Encode> Encode for BitSlice<O, T> {
fn encode_to<W: Output + ?Sized>(&self, dest: &mut W) {
let len = self.len();
assert!(
len <= u32::max_value() as usize,
"Attempted to serialize a collection with too many elements.",
);
Compact(len as u32).encode_to(dest);
let slice = self.as_slice();
encode_slice_no_len(slice, dest)
}
}
impl<O: BitOrder, T: BitStore + Encode> Encode for BitVec<O, T> {
fn encode_to<W: Output + ?Sized>(&self, dest: &mut W) {
self.as_bitslice().encode_to(dest)
}
}
impl<O: BitOrder, T: BitStore + Encode> EncodeLike for BitVec<O, T> {}
const ARCH32BIT_BITSLICE_MAX_BITS: usize = 0x1fff_ffff;
impl<O: BitOrder, T: BitStore + Decode> Decode for BitVec<O, T> {
fn decode<I: Input>(input: &mut I) -> Result<Self, Error> {
<Compact<u32>>::decode(input).and_then(move |Compact(bits)| {
if bits as usize > ARCH32BIT_BITSLICE_MAX_BITS {
return Err("Attempt to decode a bitvec with too many bits".into());
}
let required_elements = required_elements::<T>(bits)? as usize;
let vec = decode_vec_with_len(input, required_elements)?;
let mut result = Self::try_from_vec(vec)
.map_err(|_| {
Error::from("UNEXPECTED ERROR: `bits` is less or equal to
`ARCH32BIT_BITSLICE_MAX_BITS`; So BitVec must be able to handle the number of
segment needed for `bits` to be represented; qed")
})?;
assert!(bits as usize <= result.len());
result.truncate(bits as usize);
Ok(result)
})
}
}
impl<O: BitOrder, T: BitStore + Encode> Encode for BitBox<O, T> {
fn encode_to<W: Output + ?Sized>(&self, dest: &mut W) {
self.as_bitslice().encode_to(dest)
}
}
impl<O: BitOrder, T: BitStore + Encode> EncodeLike for BitBox<O, T> {}
impl<O: BitOrder, T: BitStore + Decode> Decode for BitBox<O, T> {
fn decode<I: Input>(input: &mut I) -> Result<Self, Error> {
Ok(Self::from_bitslice(BitVec::<O, T>::decode(input)?.as_bitslice()))
}
}
fn required_elements<T: BitStore>(bits: u32) -> Result<u32, Error> {
let element_bits = T::Mem::BITS as u32;
let error = Error::from("Attempt to decode bitvec with too many bits");
Ok((bits.checked_add(element_bits).ok_or_else(|| error)? - 1) / element_bits)
}
#[cfg(test)]
mod tests {
use super::*;
use bitvec::{bitvec, order::Msb0};
use crate::codec::MAX_PREALLOCATION;
macro_rules! test_data {
($inner_type:ident) => (
[
BitVec::<Msb0, $inner_type>::new(),
bitvec![Msb0, $inner_type; 0],
bitvec![Msb0, $inner_type; 1],
bitvec![Msb0, $inner_type; 0, 0],
bitvec![Msb0, $inner_type; 1, 0],
bitvec![Msb0, $inner_type; 0, 1],
bitvec![Msb0, $inner_type; 1, 1],
bitvec![Msb0, $inner_type; 1, 0, 1],
bitvec![Msb0, $inner_type; 0, 1, 0, 1, 0, 1, 1],
bitvec![Msb0, $inner_type; 0, 1, 0, 1, 0, 1, 1, 0],
bitvec![Msb0, $inner_type; 1, 1, 0, 1, 0, 1, 1, 0, 1],
bitvec![Msb0, $inner_type; 1, 0, 1, 0, 1, 1, 0, 0, 1, 0, 1, 0, 1, 1, 0],
bitvec![Msb0, $inner_type; 0, 1, 0, 1, 0, 1, 1, 0, 0, 1, 0, 1, 0, 1, 1, 0],
bitvec![Msb0, $inner_type; 0, 1, 0, 1, 0, 1, 1, 0, 0, 1, 0, 1, 0, 1, 1, 0, 0],
bitvec![Msb0, $inner_type; 0; 15],
bitvec![Msb0, $inner_type; 1; 16],
bitvec![Msb0, $inner_type; 0; 17],
bitvec![Msb0, $inner_type; 1; 31],
bitvec![Msb0, $inner_type; 0; 32],
bitvec![Msb0, $inner_type; 1; 33],
bitvec![Msb0, $inner_type; 0; 63],
bitvec![Msb0, $inner_type; 1; 64],
bitvec![Msb0, $inner_type; 0; 65],
bitvec![Msb0, $inner_type; 1; MAX_PREALLOCATION * 8 + 1],
bitvec![Msb0, $inner_type; 0; MAX_PREALLOCATION * 9],
bitvec![Msb0, $inner_type; 1; MAX_PREALLOCATION * 32 + 1],
bitvec![Msb0, $inner_type; 0; MAX_PREALLOCATION * 33],
]
)
}
#[test]
fn required_items_test() {
assert_eq!(Ok(0), required_elements::<u8>(0));
assert_eq!(Ok(1), required_elements::<u8>(1));
assert_eq!(Ok(1), required_elements::<u8>(7));
assert_eq!(Ok(1), required_elements::<u8>(8));
assert_eq!(Ok(2), required_elements::<u8>(9));
assert_eq!(Ok(0), required_elements::<u16>(0));
assert_eq!(Ok(1), required_elements::<u16>(1));
assert_eq!(Ok(1), required_elements::<u16>(15));
assert_eq!(Ok(1), required_elements::<u16>(16));
assert_eq!(Ok(2), required_elements::<u16>(17));
assert_eq!(Ok(0), required_elements::<u32>(0));
assert_eq!(Ok(1), required_elements::<u32>(1));
assert_eq!(Ok(1), required_elements::<u32>(31));
assert_eq!(Ok(1), required_elements::<u32>(32));
assert_eq!(Ok(2), required_elements::<u32>(33));
assert_eq!(Ok(0), required_elements::<u64>(0));
assert_eq!(Ok(1), required_elements::<u64>(1));
assert_eq!(Ok(1), required_elements::<u64>(63));
assert_eq!(Ok(1), required_elements::<u64>(64));
assert_eq!(Ok(2), required_elements::<u64>(65));
}
#[test]
fn bitvec_u8() {
for v in &test_data!(u8) {
let encoded = v.encode();
assert_eq!(*v, BitVec::<Msb0, u8>::decode(&mut &encoded[..]).unwrap());
}
}
#[test]
#[cfg(not(miri))]
fn bitvec_u16() {
for v in &test_data!(u16) {
let encoded = v.encode();
assert_eq!(*v, BitVec::<Msb0, u16>::decode(&mut &encoded[..]).unwrap());
}
}
#[test]
#[cfg(not(miri))]
fn bitvec_u32() {
for v in &test_data!(u32) {
let encoded = v.encode();
assert_eq!(*v, BitVec::<Msb0, u32>::decode(&mut &encoded[..]).unwrap());
}
}
#[test]
#[cfg(not(miri))]
fn bitvec_u64() {
for v in &test_data!(u64) {
let encoded = v.encode();
assert_eq!(*v, BitVec::<Msb0, u64>::decode(&mut &encoded[..]).unwrap());
}
}
#[test]
fn bitslice() {
let data: &[u8] = &[0x69];
let slice = BitSlice::<Msb0, u8>::from_slice(data).unwrap();
let encoded = slice.encode();
let decoded = BitVec::<Msb0, u8>::decode(&mut &encoded[..]).unwrap();
assert_eq!(slice, decoded.as_bitslice());
}
#[test]
#[cfg(not(miri))]
fn bitbox() {
let data: &[u8] = &[5, 10];
let slice = BitSlice::<Msb0, u8>::from_slice(data).unwrap();
let bb = BitBox::<Msb0, u8>::from_bitslice(slice);
let encoded = bb.encode();
let decoded = BitBox::<Msb0, u8>::decode(&mut &encoded[..]).unwrap();
assert_eq!(bb, decoded);
}
}