Fix UB in documentation example #93
Merged
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
tormol
reviewed
Sep 11, 2022
src/ascii_string.rs
Outdated
| @@ -65,6 +65,7 @@ impl AsciiString { | |||
| /// | |||
| /// * The memory at `buf` need to have been previously allocated by the same allocator this | |||
| /// library uses. | |||
| /// * `buf` must be obtained from a valid `&mut` reference to guarentee exclusive ownership. | |||
There was a problem hiding this comment.
I think either this is implied by *mut, or that miri is stricter than the language currently is.
The docs for String::from_raw_parts() doesn't mention this.
src/ascii_string.rs
Outdated
| @@ -98,8 +99,8 @@ impl AsciiString { | |||
| pub unsafe fn from_raw_parts(buf: *mut AsciiChar, length: usize, capacity: usize) -> Self { | |||
| AsciiString { | |||
| // SAFETY: Caller guarantees `buf` was previously allocated by this library, | |||
| // that `buf` contains `length` valid ascii elements and has a total | |||
| // capacity of `capacity` elements. | |||
| // is a unique pointer, `buf` contains `length` valid ascii elements, | |||
There was a problem hiding this comment.
The term unique pointer isn't really used in rust, and
The example creates a new `AsciiString::from_raw_parts` using a shared reference casted to a mutable pointer. This changes the example to use an exclusive reference/pointer.
|
That's probably best, I updated the docs while I was changing the example but best to match |
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.
The example creates a new
AsciiString::from_raw_partsusing a shared reference casted to a mutable pointer. This changes the example to use an exclusive reference/pointer.