Use pseudocode to document transmute, transmute_mut
#1058
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
joshlf
requested changes
Mar 19, 2024
src/lib.rs
Outdated
| /// Src: IntoBytes, | ||
| /// Dst: FromBytes, | ||
| /// size_of::<Src>() == size_of::<Dst>(), | ||
| /// align_of::<Src>() >= align_of::<Dst>(), |
There was a problem hiding this comment.
Suggested change
| /// align_of::<Src>() >= align_of::<Dst>(), |
src/lib.rs
Outdated
| /// Src: IntoBytes + FromBytes + NoCell, | ||
| /// Dst: FromBytes + IntoBytes + NoCell, |
There was a problem hiding this comment.
Suggested change
| /// Src: IntoBytes + FromBytes + NoCell, | |
| /// Dst: FromBytes + IntoBytes + NoCell, | |
| /// Src: FromBytes + IntoBytes + NoCell, | |
| /// Dst: FromBytes + IntoBytes + NoCell, |
IMO it's visually clearer this way that both types must implement the same set of traits.
joshlf
approved these changes
Mar 19, 2024
src/lib.rs
Outdated
Comment on lines
4587
to
4588
| /// Src: IntoBytes + FromBytes + NoCell, | ||
| /// Dst: IntoBytes + FromBytes + NoCell, |
There was a problem hiding this comment.
Suggested change
| /// Src: IntoBytes + FromBytes + NoCell, | |
| /// Dst: IntoBytes + FromBytes + NoCell, | |
| /// Src: FromBytes + IntoBytes + NoCell, | |
| /// Dst: FromBytes + IntoBytes + NoCell, |
Usually we list FromBytes before IntoBytes, consistent w/ the stdlib From and Into. I don't feel strongly about it, though, so feel free to leave it as-is if you prefer.
There was a problem hiding this comment.
Fair enough. Done.
Partially addresses #1046.
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.
Partially addresses #1046.