Removes IonDataSource and vestigial read() impls
#591
Merged
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
desaikd
approved these changes
Jul 3, 2023
jobarr-amzn
approved these changes
Jul 3, 2023
Comment on lines
-1156
to
+1159
| // This iterator cannot be created unless the reader is currently parked on a value. | ||
| // If the reader is parked on a value, the complete annotations sequence is in the buffer. | ||
| // Therefore, reading symbol IDs from this byte slice cannot fail. This allows us to safely | ||
| // unwrap the result of this `read` call. | ||
| let var_uint = VarUInt::read(&mut self.data).unwrap(); | ||
| let var_uint = match self.data.read_var_uint() { | ||
| Ok(var_uint) => var_uint, | ||
| Err(e) => return Some(Err(e)), | ||
| }; |
There was a problem hiding this comment.
What drives the change here? Is the context about positioning or buffered bytes different now?
There was a problem hiding this comment.
The method VarUInt::read was deleted. The rest of this type uses BinaryBuffer's read operations; this change was changing self.data from being a io::Cursor(&[u8]) that we read from using VarUInt::read() to being a BinaryBuffer<&'a [u8]> that has its own read operation.
The invariant described in the comment is still true; I think I could have kept it but didn't want to do the deep dive needed to guarantee that.
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.
The original implementation of the binary reader used a trait called
IonDataSourcethat provided extension methods for implementations ofBufRead. The binary reader was later rewritten to use a type calledBinaryBuffer, butIonDataSourceand its methods were never removed.This PR removes
IonDataSourceand the vestigial implementations ofread()for various encoding primitives that relied uponIonDataSource.Finally, it renames the single-method trait
ToIonDataSource(which suggested types could be converted to anIonDataSource) toIonDataSource, reclaiming the name for a better use.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.