Update ptr::{read,write}_unaligned docs to reference addr_of(_mut) #84778
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
|
r? @kennytm (rust-highfive has picked a reviewer for you, use r? to override) |
rust-highfive
added
the
S-waiting-on-review
|
I'm going to close in favor of the above PR, feel free to leave a comment there if you have some thoughts. Thanks! |
|
Oh whoops I didn't see that PR, that looks good! |
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
ptr::read_unalignedandptr::write_unaligneddocs state that "It is currently impossible to create raw pointers to unaligned fields of a packed struct." This is no longer true with the introduction ofaddr_of!andaddr_of_mut!. This updates the documentation to refer to those macros to create raw pointers, and copies the examples in those macros (which already used read/write unaligned).