Implements flexsym annotation reading, adds binary 1.1 roundtrip unit tests #788
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,23 +1,55 @@ | ||
| #![allow(non_camel_case_types)] | ||
| use crate::lazy::binary::raw::v1_1::immutable_buffer::{AnnotationsEncoding, ImmutableBuffer}; | ||
| use crate::lazy::encoder::binary::v1_1::flex_sym::FlexSymValue; | ||
| use crate::{IonResult, RawSymbolRef, SymbolId}; | ||
|
|
||
| /// Iterates over a slice of bytes, lazily reading them as a sequence of FlexUInt- or | ||
| /// FlexSym-encoded symbol IDs. | ||
| pub struct RawBinaryAnnotationsIterator_1_1<'a> { | ||
| buffer: ImmutableBuffer<'a>, | ||
| encoding: AnnotationsEncoding, | ||
| } | ||
|
|
||
| impl<'a> RawBinaryAnnotationsIterator_1_1<'a> { | ||
| pub(crate) fn new( | ||
| buffer: ImmutableBuffer<'a>, | ||
| encoding: AnnotationsEncoding, | ||
| ) -> RawBinaryAnnotationsIterator_1_1<'a> { | ||
| Self { buffer, encoding } | ||
| } | ||
| } | ||
|
|
||
| impl<'a> Iterator for RawBinaryAnnotationsIterator_1_1<'a> { | ||
| type Item = IonResult<RawSymbolRef<'a>>; | ||
|
|
||
| fn next(&mut self) -> Option<Self::Item> { | ||
| if self.buffer.is_empty() { | ||
| return None; | ||
| } | ||
| use AnnotationsEncoding::*; | ||
| let (raw_symbol, remaining_input) = match self.encoding { | ||
| SymbolAddress => match self.buffer.read_flex_uint() { | ||
| Ok((flex_uint, remaining_input)) => ( | ||
| RawSymbolRef::SymbolId(flex_uint.value() as SymbolId), | ||
| remaining_input, | ||
| ), | ||
| Err(error) => return Some(Err(error)), | ||
| }, | ||
| FlexSym => { | ||
| let (flex_sym, remaining_input) = match self.buffer.read_flex_sym() { | ||
| Ok((flex_sym, remaining_input)) => (flex_sym, remaining_input), | ||
| Err(error) => return Some(Err(error)), | ||
| }; | ||
| let raw_symbol = match flex_sym.value() { | ||
| FlexSymValue::SymbolRef(raw_symbol) => raw_symbol, | ||
| FlexSymValue::Opcode(_) => { | ||
| todo!("FlexSym escapes in annotation sequences") | ||
|
There was a problem hiding this comment. Are There was a problem hiding this comment. @nirosys can comment on his intent, but I believe that's the idea. |
||
| } | ||
| }; | ||
| (raw_symbol, remaining_input) | ||
| } | ||
| }; | ||
| self.buffer = remaining_input; | ||
| Some(Ok(raw_symbol)) | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,7 +3,7 @@ use crate::lazy::binary::encoded_value::EncodedValue; | |
| use crate::lazy::binary::raw::v1_1::value::{ | ||
| LazyRawBinaryValue_1_1, LazyRawBinaryVersionMarker_1_1, | ||
| }; | ||
| use crate::lazy::binary::raw::v1_1::{Header, LengthType, Opcode, OpcodeType, ION_1_1_OPCODES}; | ||
| use crate::lazy::encoder::binary::v1_1::fixed_int::FixedInt; | ||
| use crate::lazy::encoder::binary::v1_1::fixed_uint::FixedUInt; | ||
| use crate::lazy::encoder::binary::v1_1::flex_int::FlexInt; | ||
|
|
@@ -173,12 +173,6 @@ impl<'a> ImmutableBuffer<'a> { | |
| Ok((flex_sym, remaining)) | ||
| } | ||
|
|
||
|
There was a problem hiding this comment. 🗺️ I removed this stub (that I added a while ago) because v1.1 annotations don't involve a 'wrapper' like v1.0 annotations. |
||
| /// Reads a `NOP` encoding primitive from the buffer. If it is successful, returns an `Ok(_)` | ||
| /// containing the number of bytes that were consumed. | ||
| /// | ||
|
|
@@ -191,10 +185,10 @@ impl<'a> ImmutableBuffer<'a> { | |
| let opcode = self.peek_opcode()?; | ||
|
|
||
| // We need to determine the size of the nop.. | ||
| let (size, remaining) = if opcode.low_nibble() == 0xC { | ||
| // Size 0; the nop is contained entirely within the OpCode. | ||
| (0, self.consume(1)) | ||
| } else if opcode.low_nibble() == 0xD { | ||
| // We have a flexuint telling us how long our nop is. | ||
| let after_header = self.consume(1); | ||
| let (len, rest) = after_header.read_flex_uint()?; | ||
|
|
@@ -278,7 +272,7 @@ impl<'a> ImmutableBuffer<'a> { | |
| /// Reads a value from the buffer. The caller must confirm that the buffer is not empty and that | ||
| /// the next byte (`type_descriptor`) is not a NOP. | ||
| pub fn read_value(self, opcode: Opcode) -> IonResult<LazyRawBinaryValue_1_1<'a>> { | ||
| if opcode.is_annotations_sequence() { | ||
| self.read_annotated_value(opcode) | ||
| } else { | ||
| self.read_value_without_annotations(opcode) | ||
|
|
@@ -309,6 +303,7 @@ impl<'a> ImmutableBuffer<'a> { | |
| // If applicable, these are populated by the caller: `read_annotated_value()` | ||
| annotations_header_length: 0, | ||
| annotations_sequence_length: 0, | ||
| annotations_encoding: AnnotationsEncoding::SymbolAddress, | ||
| header_offset, | ||
| length_length, | ||
| value_body_length: value_length, | ||
|
|
@@ -340,19 +335,114 @@ impl<'a> ImmutableBuffer<'a> { | |
|
|
||
| /// Reads an annotations wrapper and its associated value from the buffer. The caller must confirm | ||
| /// that the next byte in the buffer (`type_descriptor`) begins an annotations wrapper. | ||
| fn read_annotated_value(self, opcode: Opcode) -> IonResult<LazyRawBinaryValue_1_1<'a>> { | ||
| let (annotations_seq, input_after_annotations) = self.read_annotations_sequence(opcode)?; | ||
| let opcode = input_after_annotations.peek_opcode()?; | ||
| let mut value = input_after_annotations.read_value_without_annotations(opcode)?; | ||
| value.encoded_value.annotations_header_length = annotations_seq.header_length; | ||
| value.encoded_value.annotations_sequence_length = annotations_seq.sequence_length; | ||
| value.encoded_value.annotations_encoding = annotations_seq.encoding; | ||
| value.encoded_value.total_length += | ||
| annotations_seq.header_length as usize + annotations_seq.sequence_length as usize; | ||
| // Rewind the input to include the annotations sequence | ||
| value.input = self; | ||
|
Comment on lines
+342
to
+348
There was a problem hiding this comment. 🗺️ After reading the value, this method goes back and overwrites all of the annotations-related or -affected fields. |
||
| Ok(value) | ||
| } | ||
|
|
||
| fn read_annotations_sequence(self, opcode: Opcode) -> ParseResult<'a, EncodedAnnotations> { | ||
| match opcode.opcode_type { | ||
| OpcodeType::AnnotationFlexSym => self.read_flex_sym_annotations_sequence(opcode), | ||
| OpcodeType::SymbolAddress => self.read_symbol_address_annotations_sequence(opcode), | ||
| _ => unreachable!("read_annotations_sequence called for non-annotations opcode"), | ||
| } | ||
| } | ||
|
|
||
| fn read_flex_sym_annotations_sequence( | ||
| self, | ||
| opcode: Opcode, | ||
| ) -> ParseResult<'a, EncodedAnnotations> { | ||
| let input_after_opcode = self.consume(1); | ||
| // TODO: This implementation actively reads the annotations, which isn't necessary. | ||
| // At this phase of parsing we can just identify the buffer slice that contains | ||
| // the annotations and remember their encoding; later on, the annotations iterator | ||
| // can actually do the reading. That optimization would be impactful for FlexSyms | ||
| // that represent inline text. | ||
| let (sequence, remaining_input) = match opcode.low_nibble() { | ||
| 7 => { | ||
|
There was a problem hiding this comment. This is misleading that we're matching There was a problem hiding this comment. Yeah, agreed. It's
ion-rust/src/lazy/binary/raw/v1_1/type_code.rs Lines 15 to 55 in 8d1178e It works well in that questions like "is it a float?" are easily answered without range checks. I'm going to rename EDIT: done in 2cef814 |
||
| let (flex_sym, remaining_input) = input_after_opcode.read_flex_sym()?; | ||
| let sequence = EncodedAnnotations { | ||
| encoding: AnnotationsEncoding::FlexSym, | ||
| header_length: 1, // 0xE7 | ||
| sequence_length: u16::try_from(flex_sym.size_in_bytes()).map_err(|_| { | ||
| IonError::decoding_error( | ||
| "the maximum supported annotations sequence length is 65KB.", | ||
| ) | ||
| })?, | ||
| }; | ||
| (sequence, remaining_input) | ||
| } | ||
| 8 => { | ||
| let (flex_sym1, input_after_sym1) = input_after_opcode.read_flex_sym()?; | ||
| let (flex_sym2, input_after_sym2) = input_after_sym1.read_flex_sym()?; | ||
| let combined_length = flex_sym1.size_in_bytes() + flex_sym2.size_in_bytes(); | ||
| let sequence = EncodedAnnotations { | ||
| encoding: AnnotationsEncoding::FlexSym, | ||
| header_length: 1, // 0xE8 | ||
| sequence_length: u16::try_from(combined_length).map_err(|_| { | ||
| IonError::decoding_error( | ||
| "the maximum supported annotations sequence length is 65KB.", | ||
| ) | ||
| })?, | ||
| }; | ||
| (sequence, input_after_sym2) | ||
| } | ||
| 9 => { | ||
| let (flex_uint, remaining_input) = input_after_opcode.read_flex_uint()?; | ||
| let sequence = EncodedAnnotations { | ||
| encoding: AnnotationsEncoding::FlexSym, | ||
| header_length: u8::try_from(1 + flex_uint.size_in_bytes()).map_err(|_| { | ||
| IonError::decoding_error("found a 256+ byte annotations header") | ||
|
There was a problem hiding this comment. Can There was a problem hiding this comment. It can't; the current implementation would always raise an error during the There was a problem hiding this comment. I'm going to leave this as-is for the moment. If profiling shows that an |
||
| })?, | ||
| sequence_length: u16::try_from(flex_uint.value()).map_err(|_| { | ||
| IonError::decoding_error( | ||
| "the maximum supported annotations sequence length is 65KB.", | ||
| ) | ||
| })?, | ||
| }; | ||
| ( | ||
| sequence, | ||
| remaining_input.consume(sequence.sequence_length as usize), | ||
| ) | ||
| } | ||
| _ => unreachable!("reading flexsym annotations sequence with invalid length code"), | ||
| }; | ||
| Ok((sequence, remaining_input)) | ||
| } | ||
|
|
||
| fn read_symbol_address_annotations_sequence( | ||
| self, | ||
| _opcode: Opcode, | ||
| ) -> ParseResult<'a, EncodedAnnotations> { | ||
| todo!() | ||
| } | ||
| } | ||
|
|
||
| #[derive(Clone, Copy, Debug, PartialEq)] | ||
| pub enum AnnotationsEncoding { | ||
| SymbolAddress, | ||
| FlexSym, | ||
| } | ||
|
|
||
| /// Represents the data found in an Ion 1.1 annotations sequence | ||
| #[derive(Clone, Copy, Debug)] | ||
| pub struct EncodedAnnotations { | ||
| pub encoding: AnnotationsEncoding, | ||
| // The number of bytes used to represent the annotations opcode and the byte length prefix | ||
| // (in the case of 0xE9). As a result, this will almost always be 1 or 2. | ||
| pub header_length: u8, | ||
| // The number of bytes used to represent the annotations sequence itself. Because these | ||
| // can be encoded with inline text, it's possible for the length to be non-trivial. | ||
| pub sequence_length: u16, | ||
| } | ||
|
|
||
| #[cfg(test)] | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -536,17 +536,17 @@ mod tests { | |
| #[case("2024T", &[0x80, 0x36])] | ||
| #[case("2023-10T", &[0x81, 0x35, 0x05])] | ||
| #[case("2023-10-15T", &[0x82, 0x35, 0x7D])] | ||
| #[case("2023-10-15T05:04Z", &[0x83, 0x35, 0x7D, 0x85, 0x00])] | ||
| #[case("2023-10-15T05:04:03Z", &[0x84, 0x35, 0x7D, 0x85, 0x30, 0x00])] | ||
| #[case("2023-10-15T05:04:03.123-00:00", &[0x85, 0x35, 0x7D, 0x85, 0x38, 0xEC, 0x01])] | ||
| #[case("2023-10-15T05:04:03.000123-00:00", &[0x86, 0x35, 0x7D, 0x85, 0x38, 0xEC, 0x01, 0x00])] | ||
| #[case("2023-10-15T05:04:03.000000123-00:00", &[0x87, 0x35, 0x7D, 0x85, 0x38, 0xEC, 0x01, 0x00, 0x00])] | ||
| #[case("2023-10-15T05:04+01:00", &[0x88, 0x35, 0x7D, 0x85, 0xE0, 0x01])] | ||
| #[case("2023-10-15T05:04-01:00", &[0x88, 0x35, 0x7D, 0x85, 0xA0, 0x01])] | ||
| #[case("2023-10-15T05:04:03+01:00", &[0x89, 0x35, 0x7D, 0x85, 0xE0, 0x0D])] | ||
| #[case("2023-10-15T05:04:03.123+01:00", &[0x8A, 0x35, 0x7D, 0x85, 0xE0, 0x0D, 0x7B, 0x00])] | ||
| #[case("2023-10-15T05:04:03.000123+01:00", &[0x8B, 0x35, 0x7D, 0x85, 0xE0, 0x0D, 0x7B, 0x00, 0x00])] | ||
| #[case("2023-10-15T05:04:03.000000123+01:00", &[0x8C, 0x35, 0x7D, 0x85, 0xE0, 0x0D, 0x7B, 0x00, 0x00, 0x00])] | ||
|
Comment on lines
+539
to
+549
There was a problem hiding this comment. 🗺️ The reader was treating the |
||
| fn timestamps_short(#[case] expected_txt: &str, #[case] ion_data: &[u8]) -> IonResult<()> { | ||
| use crate::lazy::decoder::{LazyRawReader, LazyRawValue}; | ||
| use crate::lazy::text::raw::v1_1::reader::LazyRawTextReader_1_1; | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🗺️ I widened the annotations sequence length from a
u8to au16since the annotations in v1.1 may have inline text.