Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

pointer::wrapping_offset should mention provenance #139008

Open
lolbinarycat opened this issue Mar 27, 2025 · 0 comments · May be fixed by #139192
Open

pointer::wrapping_offset should mention provenance #139008

lolbinarycat opened this issue Mar 27, 2025 · 0 comments · May be fixed by #139192
Assignees
@lolbinarycat
Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools needs-triage This issue may need triage. Remove it if it has been sufficiently triaged.

Comments

@lolbinarycat
Copy link
Contributor

Location

https://doc.rust-lang.org/std/primitive.pointer.html#method.wrapping_offset

Summary

The resulting pointer “remembers” the allocated object that self points to; it must not be used to read or write other allocated objects.

This is describing provenance, but it seems to have been written before rust's provenance rules started getting written down, as it does not use the word, nor does it link to the section.
@lolbinarycat lolbinarycat added the A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools label Mar 27, 2025
@rustbot rustbot added the needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. label Mar 27, 2025
@lolbinarycat lolbinarycat self-assigned this Mar 31, 2025
@lolbinarycat lolbinarycat changed the title pointer::wrapping_offset should mention provenence pointer::wrapping_offset should mention provenance Mar 31, 2025
lolbinarycat added a commit to lolbinarycat/rust that referenced this issue Mar 31, 2025
@lolbinarycat
mention provenance in the pointer::wrapping_offset docs
56d6017 
fixes rust-lang#139008
@lolbinarycat lolbinarycat linked a pull request Mar 31, 2025 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@lolbinarycat lolbinarycat

Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools needs-triage This issue may need triage. Remove it if it has been sufficiently triaged.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

mention provenance in the pointer::wrapping_offset docs lolbinarycat/rust
2 participants
@lolbinarycat @rustbot