improve from_raw_parts docs #66111
Merged
improve from_raw_parts docs #66111
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
rust-highfive
added
the
S-waiting-on-review
This comment has been minimized.
This comment has been minimized.
Centril
reviewed
Nov 5, 2019
| @@ -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.
This is fairly abstract and packed -- can we give an example perhaps?
There was a problem hiding this comment.
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.
Ah; alright -- better to have some docs than none. r=me if you are happy with the current state.
Co-Authored-By: Mazdak Farrokhzad <[email protected]>
Centril
added
S-waiting-on-author
|
@bors r=Centril |
|
📌 Commit 11a48a0 has been approved by |
bors
added
S-waiting-on-bors
pietroalbini
added a commit
to pietroalbini/rust
that referenced
this pull request
Nov 6, 2019
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
JohnTitor
added a commit
to JohnTitor/rust
that referenced
this pull request
Nov 6, 2019
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
JohnTitor
added a commit
to JohnTitor/rust
that referenced
this pull request
Nov 7, 2019
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
bors
added a commit
that referenced
this pull request
Nov 7, 2019
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
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.
Triggered by rust-lang/rfcs#2806. Hopefully this helps clarify that joining slices across allocations is not possible in Rust currently.
r? @Centril