Improve safety warning on ptr::swap #38910
Merged
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
GuillaumeGomez
requested changes
Jan 7, 2017
| @@ -74,7 +74,10 @@ pub const fn null_mut<T>() -> *mut T { 0 as *mut T } | |||
| /// | |||
| /// # Safety | |||
| /// | |||
| /// This is only unsafe because it accepts a raw pointer. | |||
| /// This function copies the memory through the raw pointers passed to it | |||
| /// as arguments, which means they will be dereferenced. | |||
There was a problem hiding this comment.
I don't think the warning is clear enough. I'd state something like:
"If the pointer is null or points to invalid data, the program will crash or have an undefined behaviour."
It seems very important to me to indicate the consequences.
There was a problem hiding this comment.
This is already defined at the language level; repeating it here feels extraneous.
There was a problem hiding this comment.
To say that it reads and writes through the raw pointers should be enough.
|
@bluss updated |
|
@bors r=eddyb |
|
📌 Commit 95fe6ac has been approved by |
GuillaumeGomez
approved these changes
Jan 8, 2017
|
☀️ Test successful - status-appveyor, status-travis |
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.
r? @eddyb @bluss , who I asked about this on IRC