Enables the StreamingRawReader to detect incomplete text #784
Conversation
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
zslayton
force-pushed
the
detect-incomplete-text
branch
from
a4451e0 to
66a4683
Compare
zslayton
commented
Jun 5, 2024
| @@ -402,6 +396,16 @@ impl<'data> LazyRawReader<'data, AnyEncoding> for LazyRawAnyReader<'data> { | |||
| Binary_1_1(r) => r.position(), | |||
| } | |||
| } | |||
|
|
|||
| fn encoding(&self) -> IonEncoding { | |||
There was a problem hiding this comment.
🗺️ All raw readers now provide a fn encoding(&self) -> IonEncoding, which allows generic code to tell which Ion encoding it's working with.
src/lazy/binary/raw/value.rs
Outdated
| @@ -258,7 +258,7 @@ impl<'a, 'top> EncodedBinaryValueData_1_0<'a, 'top> { | |||
| /// value's body (that is: the content of the value that follows its opcode and length). | |||
| pub fn body_range(&self) -> Range<usize> { | |||
| let encoded = &self.value.encoded_value; | |||
| let body_offset = encoded.header_length(); | |||
| let body_offset = encoded.annotations_header_length as usize + encoded.header_length(); | |||
There was a problem hiding this comment.
🗺️ This fixes a bug that the ion-cli has to work around.
popematt
approved these changes
Jun 5, 2024
nirosys
approved these changes
Jun 5, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
In binary encodings, stream items contain enough data for the reader to tell whether they are complete. In text encodings, it's possible for the buffer to end with data that looks like a complete item but is not. The only way to be certain is to try to read again from the input source to confirm there's no more data. Consider the following examples in which Ion is being pulled from a
Fileinto aVec<u8>:To avoid misinterpreting the data, the
StreamingRawReadernow performs a final check for text readers who have emptied their buffer: it does not consider the item complete unless the input source is exhausted.Other changes:
IonStreama public part of theexperimental-reader-writerAPI.EncodedBinaryValueData_1_0::body_spanthat caused it to fail if the value in question was annotated.The three commits are each self-contained; reviewing them separately may be helpful.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.