-
Notifications
You must be signed in to change notification settings - Fork 12.7k
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.
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
improve from_raw_parts docs #66111
improve from_raw_parts docs #66111
Conversation
This comment has been minimized.
This comment has been minimized.
@@ -18,6 +18,10 @@ | |||
//! * A [null] pointer is *never* valid, not even for accesses of [size zero][zst]. | |||
//! * All pointers (except for the null pointer) are valid for all operations of | |||
//! [size zero][zst]. | |||
//! * For a pointer to be valid, it is necessary (but not always sufficient) that the pointer | |||
//! be *dereferencable*: the memory range of the given size starting at the pointer must all be |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is fairly abstract and packed -- can we give an example perhaps?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's not really a good way (that I can think of) to do that in the current format -- it would need basically a re-write of this section, I think. And the phrasing is similar to our existing docs for, e.g., ptr::offset
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah; alright -- better to have some docs than none. r=me if you are happy with the current state.
Co-Authored-By: Mazdak Farrokhzad <twingoow@gmail.com>
@bors r=Centril |
📌 Commit 11a48a0 has been approved by |
improve from_raw_parts docs Triggered by rust-lang/rfcs#2806. Hopefully this helps clarify that joining slices across allocations is not possible in Rust currently. r? @Centril
improve from_raw_parts docs Triggered by rust-lang/rfcs#2806. Hopefully this helps clarify that joining slices across allocations is not possible in Rust currently. r? @Centril
improve from_raw_parts docs Triggered by rust-lang/rfcs#2806. Hopefully this helps clarify that joining slices across allocations is not possible in Rust currently. r? @Centril
Rollup of 12 pull requests Successful merges: - #65794 (gate rustc_on_unimplemented under rustc_attrs) - #65945 (Optimize long-linker-command-line test) - #66044 (Improve uninit/zeroed lint) - #66076 (HIR docs: mention how to resolve method paths) - #66084 (Do not require extra LLVM backends for `x.py test` to pass) - #66111 (improve from_raw_parts docs) - #66114 (Improve std::thread::Result documentation) - #66117 (Fixed PhantomData markers in Arc and Rc) - #66146 (Remove unused parameters in `__thread_local_inner`) - #66147 (Miri: Refactor to_scalar_ptr out of existence) - #66162 (Fix broken link in README) - #66171 (Update link on CONTRIBUTING.md) Failed merges: r? @ghost
Triggered by rust-lang/rfcs#2806. Hopefully this helps clarify that joining slices across allocations is not possible in Rust currently.
r? @Centril