docs: Add Portability section for TryFromBytes enum usage #1993
Conversation
This file contains hidden or 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
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
jswrenn
requested changes
Oct 30, 2024
src/lib.rs
Outdated
Comment on lines
1194
to
1195
| /// # use zerocopy::{TryFromBytes, KnownLayout, IntoBytes, Immutable}; | ||
| /// #[derive(Debug, KnownLayout, Immutable, IntoBytes, TryFromBytes)] |
There was a problem hiding this comment.
Suggested change
| /// # use zerocopy::{TryFromBytes, KnownLayout, IntoBytes, Immutable}; | |
| /// #[derive(Debug, KnownLayout, Immutable, IntoBytes, TryFromBytes)] | |
| /// # use zerocopy_derive::TryFromBytes; | |
| /// #[derive(TryFromBytes)] |
There was a problem hiding this comment.
Ohh, I thought it relates to example. sorry for that. I am going to change it.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1993 +/- ##
=======================================
Coverage 89.46% 89.46%
=======================================
Files 16 16
Lines 5838 5838
=======================================
Hits 5223 5223
Misses 615 615 ☔ View full report in Codecov by Sentry. |
jswrenn
requested changes
Nov 1, 2024
src/lib.rs
Outdated
Comment on lines
1185
to
1204
| /// # Portability | ||
| /// | ||
| /// To ensure consistent endianness for enums with multi-byte representations, | ||
| /// explicitly specify and convert each discriminant: | ||
| /// | ||
| /// Here, `DataStoreVersion` enforces little-endian encoding for each `u32` | ||
| /// discriminant, ensuring portability across platforms with differing native endianness. | ||
| /// | ||
| /// ``` | ||
| /// # use zerocopy_derive::TryFromBytes; | ||
| /// #[derive(TryFromBytes)] | ||
| /// #[repr(u32)] | ||
| /// pub enum DataStoreVersion { | ||
| /// /// Version 1 of the data store. | ||
| /// V1 = 9u32.to_le(), | ||
| /// | ||
| /// /// Version 2 of the data store. | ||
| /// V2 = 10u32.to_le(), | ||
| /// } | ||
| /// ``` | ||
| /// |
There was a problem hiding this comment.
Tightening up the prose a bit:
Suggested change
| /// # Portability | |
| /// | |
| /// To ensure consistent endianness for enums with multi-byte representations, | |
| /// explicitly specify and convert each discriminant: | |
| /// | |
| /// Here, `DataStoreVersion` enforces little-endian encoding for each `u32` | |
| /// discriminant, ensuring portability across platforms with differing native endianness. | |
| /// | |
| /// ``` | |
| /// # use zerocopy_derive::TryFromBytes; | |
| /// #[derive(TryFromBytes)] | |
| /// #[repr(u32)] | |
| /// pub enum DataStoreVersion { | |
| /// /// Version 1 of the data store. | |
| /// V1 = 9u32.to_le(), | |
| /// | |
| /// /// Version 2 of the data store. | |
| /// V2 = 10u32.to_le(), | |
| /// } | |
| /// ``` | |
| /// | |
| /// # Portability | |
| /// | |
| /// To ensure consistent endianness for enums with multi-byte representations, | |
| /// explicitly specify and convert each discriminant using `.to_le()` or | |
| /// `.to_be()`; e.g.: | |
| /// | |
| /// ``` | |
| /// # use zerocopy_derive::TryFromBytes; | |
| /// // `DataStoreVersion` is encoded in little-endian. | |
| /// #[derive(TryFromBytes)] | |
| /// #[repr(u32)] | |
| /// pub enum DataStoreVersion { | |
| /// /// Version 1 of the data store. | |
| /// V1 = 9u32.to_le(), | |
| /// | |
| /// /// Version 2 of the data store. | |
| /// V2 = 10u32.to_le(), | |
| /// } | |
| /// ``` | |
| /// |
jswrenn
approved these changes
Nov 1, 2024
google-pr-creation-bot
pushed a commit
to google-pr-creation-bot/zerocopy
that referenced
this pull request
Feb 25, 2025
|
Backporting in #2390 |
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.
closes #1778