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
329
use crate::binary_parser_types::*;
use num_bigint::{BigInt, BigUint, Sign};
use std::fmt::Debug;
use std::io::Read;
pub struct IonBinaryParser<T: Read> {
reader: T,
current_ion_version: Option<(u8, u8)>,
}
impl<T: Read> IonBinaryParser<T> {
pub fn new(reader: T) -> IonBinaryParser<T> {
IonBinaryParser {
reader,
current_ion_version: None,
}
}
fn read(&mut self, buffer: &mut [u8]) -> Result<usize, std::io::Error> {
self.reader.read(buffer)
}
// 7 0
// +-------------------------+
// UInt field | bits |
// +-------------------------+
// : bits :
// +=========================+
// ⋮
// +=========================+
// : bits :
// +=========================+
// n+7 n
pub fn consume_uint(&mut self, octets: usize) -> Result<BigUint, ParsingError> {
if octets == 0 {
return Err(ParsingError::CannotReadZeroBytes);
}
let mut buffer = vec![0u8; octets];
self.read_bytes(&mut buffer)?;
let number = BigUint::from_bytes_be(&buffer);
Ok(number)
}
pub fn read_bytes(&mut self, buffer: &mut [u8]) -> Result<(), ParsingError> {
let read_bytes = self.read(buffer);
match read_bytes {
Ok(0) => Err(ParsingError::NoDataToRead),
Err(e) => Err(ParsingError::ErrorReadingData(e.to_string())),
Ok(len) => {
if len < buffer.len() {
return Err(ParsingError::NotEnoughtDataToRead(len));
}
Ok(())
}
}
}
// 7 6 0
// +---+---------------------+
// Int field | | bits |
// +---+---------------------+
// ^
// |
// +--sign
// +=========================+
// : bits :
// +=========================+
// ⋮
// +=========================+
// : bits :
// +=========================+
// n+7 n
pub fn consume_int(&mut self, octets: usize) -> Result<BigInt, ParsingError> {
if octets == 0 {
return Err(ParsingError::CannotReadZeroBytes);
}
let mut buffer = vec![0u8; octets];
self.read_bytes(&mut buffer)?;
let is_negative = (buffer[0] & 0b1000_0000) > 0;
buffer[0] &= 0b0111_1111;
let mut number = BigInt::from_bytes_be(Sign::Plus, &buffer);
if is_negative {
number = -number;
}
Ok(number)
}
// 7 6 0 n+7 n+6 n
// +===+=====================+ +---+---------------------+
// VarUInt field : 0 : bits : … | 1 | bits |
// +===+=====================+ +---+---------------------+
pub fn consume_varuint(&mut self) -> Result<(BigUint, usize), ParsingError> {
let found_bytes = self.consume_var_number()?;
let bytes: Vec<u8> = found_bytes
.into_iter()
.map(|byte| byte & 0b0111_1111)
.collect();
let number = match BigUint::from_radix_be(&bytes, 128) {
Some(number) => number,
None => return Err(ParsingError::ThisIsABugConsumingVarUInt),
};
Ok((number, bytes.len()))
}
// 7 6 5 0 n+7 n+6 n
// +===+ +---+
// VarInt field : 0 : payload … | 1 | payload
// +===+ +---+
// +---+-----------------+ +=====================+
// | | magnitude | … : magnitude :
// +---+-----------------+ +=====================+
// ^ ^ ^
// | | |
// | +--sign +--end flag
// +--end flag
//
// 7 6 5 0
// +---+---+-------------+
// single octet VarInt field | 1 | | magnitude |
// +---+---+-------------+
// ^
// |
// +--sign
pub fn consume_varint(&mut self) -> Result<(BigInt, usize), ParsingError> {
let found_bytes = self.consume_var_number()?;
let mut bytes: Vec<u8> = found_bytes
.into_iter()
.map(|byte| byte & 0b0111_1111)
.collect();
let is_negative = bytes[0] & 0b0100_0000 > 0;
bytes[0] &= 0b0011_1111;
let mut number = match BigInt::from_radix_be(Sign::Plus, &bytes, 128) {
Some(number) => number,
None => return Err(ParsingError::ThisIsABugConsumingVarInt),
};
if is_negative {
number = -number;
}
Ok((number, bytes.len()))
}
// Note: Guarantees to return at least one byte if it succeed
fn consume_var_number(&mut self) -> Result<Vec<u8>, ParsingError> {
let mut byte = [0u8; 1];
let mut found_bytes: Vec<u8> = vec![];
loop {
let read_bytes = self.read(&mut byte);
match read_bytes {
Ok(0) => return Err(ParsingError::NoDataToRead),
Err(e) => return Err(ParsingError::ErrorReadingData(e.to_string())),
Ok(_) => {
found_bytes.push(byte[0]);
// Last byte is marked with a 1 in the highest bite
if 0b1000_0000 & byte[0] == 0b1000_0000 {
break;
}
}
}
}
Ok(found_bytes)
}
// 7 4 3 0
// +---------+---------+
// | T | L |
// +---------+---------+
pub fn consume_value_header(&mut self) -> Result<ValueHeader, ParsingError> {
let mut byte = [0u8; 1];
let read_bytes = self.read(&mut byte);
match read_bytes {
Ok(0) => Err(ParsingError::NoDataToRead),
Err(e) => Err(ParsingError::ErrorReadingData(e.to_string())),
Ok(_) => {
let byte = byte[0];
// If the byte has T as E (annotation) with a L of 0 (invalid)
// it means that this is a ion version header, so we read it
// and set the decoder to the new version.
if byte == 0xE0 {
let version = self.consume_ion_version_once_identified()?;
self.set_current_ion_version(version);
return self.consume_value_header();
}
let value_type = (byte & 0b1111_0000) >> 4;
let value_length = byte & 0b0000_1111;
let value_type = self.get_field_type(value_type);
let value_length = self.get_field_length(value_length);
match (value_type, value_length) {
(Ok(mut r#type), Ok(length)) => {
self.verify_header(&r#type, &length)?;
self.if_nop_fill_nop_padding(&mut r#type, &length);
Ok(ValueHeader { r#type, length })
}
(Err(e), _) => Err(e),
(_, Err(e)) => Err(e),
}
}
}
}
fn if_nop_fill_nop_padding(&self, r#type: &mut ValueType, length: &ValueLength) {
match (&r#type, &length) {
(ValueType::Null, ValueLength::ShortLength(_))
| (ValueType::Null, ValueLength::LongLength) => {
*r#type = ValueType::Nop;
}
_ => {}
}
}
fn verify_header(&self, valtype: &ValueType, length: &ValueLength) -> Result<(), ParsingError> {
use ValueLength::*;
use ValueType::*;
match valtype {
Annotation => {
if let ShortLength(len) = length {
if len < &3 {
Err(ParsingError::InvalidAnnotationLength(length.clone()))
} else {
Ok(())
}
} else {
Ok(())
}
}
_ => Ok(()),
}
}
// 7 0 7 0 7 0 7 0
// +------+-------+-------+------+
// binary version marker | 0xE0 | major | minor | 0xEA |
// +------+-------+-------+------+
// When calling this function we have already consumed the first byte
// (that is how we identify we need to call this function)
fn consume_ion_version_once_identified(&mut self) -> Result<(u8, u8), ParsingError> {
let mut byte = [0u8; 3];
let read_bytes = self.read(&mut byte);
match read_bytes {
Ok(0) => Err(ParsingError::NoDataToRead),
Err(e) => Err(ParsingError::ErrorReadingData(e.to_string())),
Ok(_) => {
if byte[2] != 0xEA {
return Err(ParsingError::BadFormedVersionHeader);
}
Ok((byte[0], byte[1]))
}
}
}
fn set_current_ion_version(&mut self, version: (u8, u8)) {
self.current_ion_version = Some(version);
}
fn get_field_type(&mut self, id: u8) -> Result<ValueType, ParsingError> {
match id {
0 => Ok(ValueType::Null),
1 => Ok(ValueType::Bool),
2 => Ok(ValueType::PositiveInt),
3 => Ok(ValueType::NegativeInt),
4 => Ok(ValueType::Float),
5 => Ok(ValueType::Decimal),
6 => Ok(ValueType::Timestamp),
7 => Ok(ValueType::Symbol),
8 => Ok(ValueType::String),
9 => Ok(ValueType::Clob),
10 => Ok(ValueType::Blob),
11 => Ok(ValueType::List),
12 => Ok(ValueType::SExpr),
13 => Ok(ValueType::Struct),
14 => Ok(ValueType::Annotation),
15 => Ok(ValueType::Reserved),
_ => Err(ParsingError::InvalidHeaderType),
}
}
fn get_field_length(&mut self, id: u8) -> Result<ValueLength, ParsingError> {
match id {
14 => Ok(ValueLength::LongLength), // L = 14 real length is in this field's following field: "length [VarUInt]"
15 => Ok(ValueLength::NullValue), // L = 15
0..=13 => Ok(ValueLength::ShortLength(id)), // 0 <= L <= 13 and we omit the "length [VarUInt]" field,
_ => Err(ParsingError::InvalidHeaderLength),
}
}
}
impl<T: Read> Debug for IonBinaryParser<T> {
fn fmt(&self, fmt: &mut std::fmt::Formatter<'_>) -> Result<(), std::fmt::Error> {
fmt.debug_struct("IonBinaryParser").finish()
}
}