Add link to ownership section in ptr::read docs - #161889
Merged
Merged
Conversation
rustbot
added
S-waiting-on-review
Member
|
Annoyance is a fickle motivator @bors r+ rollup |
Contributor
rust-bors
Bot
added
S-waiting-on-bors
JonathanBrouwer
added a commit
to JonathanBrouwer/rust
that referenced
this pull request
Aug 28, 2026
…sDenton Add link to ownership section in ptr::read docs This one has annoyed me for a while but I never found it worth fixing. One of the safety requirements of `read` is that you handle ownership correctly. All `read`-like functions in the `ptr` module (e.g. `copy`, `read_unaligned`) state that "just like `read`", you have to take care around this, and they link to the section on ownership in the `read` docs. However, `read` does not do so in its own safety requirements, and worse yet, you have to *scroll down* to see the section. Every so often I look at this function and think ownership is missing from the docs, before remembering this. This PR just adds a link to make sure users don't miss this. r? libs
JonathanBrouwer
added a commit
to JonathanBrouwer/rust
that referenced
this pull request
Aug 28, 2026
…sDenton Add link to ownership section in ptr::read docs This one has annoyed me for a while but I never found it worth fixing. One of the safety requirements of `read` is that you handle ownership correctly. All `read`-like functions in the `ptr` module (e.g. `copy`, `read_unaligned`) state that "just like `read`", you have to take care around this, and they link to the section on ownership in the `read` docs. However, `read` does not do so in its own safety requirements, and worse yet, you have to *scroll down* to see the section. Every so often I look at this function and think ownership is missing from the docs, before remembering this. This PR just adds a link to make sure users don't miss this. r? libs
rust-bors Bot
pushed a commit
that referenced
this pull request
Aug 28, 2026
…uwer Rollup of 21 pull requests Successful merges: - #158609 (Update sccache to 0.16.0) - #150075 (Implement clamp_to) - #159103 (fix(reborrow): recursive implementation) - #160562 (add target feature ABI checks for SPARC) - #160848 (std: avoid aliasing violations when wrapping opaque C types) - #161421 (Include startup crt objects on WASI for more outputs) - #161805 (Prefer ambiguous candidates when deduplicating traits in scope, so `ambiguous_glob_imported_traits` doesn't depend on import order) - #161862 (Put data segment in specified section with link_section on wasm) - #161866 (delegation: add tests fixating behavior of delegating to default trait implementations) - #161456 (reduce perf impact of scalar size checks) - #161528 (Add regression test to ensure optimal compilation) - #161666 (Print vendor instructions in `x vendor`) - #161730 (Improve type mismatch annotation for lets with block-wrapped initializers) - #161828 (Never type after-stabilization cleanup) - #161859 (Do not optimize MIR for comptime ConstFns) - #161860 (atomicptr.rs test: remove unused import) - #161870 (bind to [::1] instead of 127.0.0.1 in documentation examples for v6 UDP methods) - #161876 (rustdoc: Correctly handle when a macro generates multiple items in `--generate-macro-expansion`) - #161889 (Add link to ownership section in ptr::read docs) - #161890 (rustdoc: some clarifying comments) - #161891 (Mark `extern_item_impls` feature as incomplete) Failed merges: - #161702 (Use `drop_guard` in some places in {core,alloc,std})
rust-bors Bot
pushed a commit
that referenced
this pull request
Aug 28, 2026
…uwer Rollup of 21 pull requests Successful merges: - #150075 (Implement clamp_to) - #159103 (fix(reborrow): recursive implementation) - #160562 (add target feature ABI checks for SPARC) - #160848 (std: avoid aliasing violations when wrapping opaque C types) - #161421 (Include startup crt objects on WASI for more outputs) - #161805 (Prefer ambiguous candidates when deduplicating traits in scope, so `ambiguous_glob_imported_traits` doesn't depend on import order) - #161862 (Put data segment in specified section with link_section on wasm) - #161866 (delegation: add tests fixating behavior of delegating to default trait implementations) - #157218 (Track items behind `cfg_select` in the same way we do for `cfg`) - #161456 (reduce perf impact of scalar size checks) - #161528 (Add regression test to ensure optimal compilation) - #161666 (Print vendor instructions in `x vendor`) - #161730 (Improve type mismatch annotation for lets with block-wrapped initializers) - #161828 (Never type after-stabilization cleanup) - #161859 (Do not optimize MIR for comptime ConstFns) - #161860 (atomicptr.rs test: remove unused import) - #161870 (bind to [::1] instead of 127.0.0.1 in documentation examples for v6 UDP methods) - #161876 (rustdoc: Correctly handle when a macro generates multiple items in `--generate-macro-expansion`) - #161889 (Add link to ownership section in ptr::read docs) - #161890 (rustdoc: some clarifying comments) - #161891 (Mark `extern_item_impls` feature as incomplete) Failed merges: - #161702 (Use `drop_guard` in some places in {core,alloc,std})
rust-bors Bot
pushed a commit
that referenced
this pull request
Aug 28, 2026
Rollup merge of #161889 - maxdexh:ptr-read-ownership, r=ChrisDenton Add link to ownership section in ptr::read docs This one has annoyed me for a while but I never found it worth fixing. One of the safety requirements of `read` is that you handle ownership correctly. All `read`-like functions in the `ptr` module (e.g. `copy`, `read_unaligned`) state that "just like `read`", you have to take care around this, and they link to the section on ownership in the `read` docs. However, `read` does not do so in its own safety requirements, and worse yet, you have to *scroll down* to see the section. Every so often I look at this function and think ownership is missing from the docs, before remembering this. This PR just adds a link to make sure users don't miss this. r? libs
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
This one has annoyed me for a while but I never found it worth fixing.
One of the safety requirements of
readis that you handle ownership correctly.All
read-like functions in theptrmodule (e.g.copy,read_unaligned) state that "just likeread", you have to take care around this, and they link to the section on ownership in thereaddocs.However,
readdoes not do so in its own safety requirements, and worse yet, you have to scroll down to see the section.Every so often I look at this function and think ownership is missing from the docs, before remembering this.
This PR just adds a link to make sure users don't miss this.
r? libs