Add API for getting endianness of a binary resource bundle #4804
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
sffc
previously approved these changes
Apr 19, 2024
utils/resb/src/binary.rs
Outdated
| @@ -152,7 +112,8 @@ primitive_enum!( | |||
| u8, | |||
| /// The endianness used to write a resource bundle. | |||
| #[derive(Clone, Copy, Debug, PartialEq)] | |||
| enum Endianness { | |||
| #[allow(clippy::exhaustive_enums, missing_docs)] | |||
There was a problem hiding this comment.
Suggested change
| #[allow(clippy::exhaustive_enums, missing_docs)] | |
| #[allow(clippy::exhaustive_enums)] // only two types of endianness |
There was a problem hiding this comment.
I added missing_docs because otherwise it complains about a lack of documentation for the variants. In theory, I could put something there, but... what?
utils/resb/src/binary.rs
Outdated
Comment on lines
444
to
449
| let rest = | ||
| input | ||
| .get(core::mem::size_of::<u16>()..) | ||
| .ok_or(BinaryDeserializerError::invalid_data( | ||
| "unexpected end of input", | ||
| ))?; |
There was a problem hiding this comment.
Suggestion: use your new helper function get_subslice
Comment on lines
+436
to
+439
| // Safe to unwrap at the end of this because `try_into()` for arrays will | ||
| // only fail if the slice is the wrong size. | ||
| #[allow(clippy::unwrap_used)] | ||
| let bytes = get_subslice(input, ..core::mem::size_of::<u16>())? |
There was a problem hiding this comment.
Yet another use case for rust-lang/rust#119128
Suggested change
| // Safe to unwrap at the end of this because `try_into()` for arrays will | |
| // only fail if the slice is the wrong size. | |
| #[allow(clippy::unwrap_used)] | |
| let bytes = get_subslice(input, ..core::mem::size_of::<u16>())? | |
| // Safe to unwrap at the end of this because `try_into()` for arrays will | |
| // only fail if the slice is the wrong size. | |
| // TODO: Use split_at_checked when available | |
| // <https://github.com/rust-lang/rust/issues/119128> | |
| #[allow(clippy::unwrap_used)] | |
| let bytes = get_subslice(input, ..core::mem::size_of::<u16>())? |
sffc
approved these changes
Apr 25, 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.
Resource bundles for time zone data are serialized with intvector fields containing 64-bit integers which are serialized in an ad hoc, endian-sensitive manner (due to lack of 64-bit integer support in resb). Since this isn't a part of the standard and is required for correct interpretation of time zone data, it's necessary to provide a means of determining bundle endianness for consumers using the serde deserializer.
Note that big endian resource bundles aren't presently supported, but this support is planned in order to support big endian systems or systems where resource bundles intended for use with icu4j are present.