Add doc examples to str::from_utf8_unchecked_mut #44477
Conversation
|
Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @aturon (or someone else) soon. If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes. Please see the contribution instructions for more information. |
|
r? @frewsxcv Thank you for the PR!! |
carols10cents
added
the
S-waiting-on-review
src/libcore/str/mod.rs
Outdated
| /// let mut bytes = vec![240, 40, 140, 188]; | ||
| /// | ||
| /// // Returns a str: | ||
| /// unsafe { str::from_utf8_unchecked_mut(&mut bytes) }; |
There was a problem hiding this comment.
it turns out that constructing an invalid string in an 'unchecked' manner is considered "undefined behavior" and not something we want to add in here. although it might not be obvious for such a simple example as this, this sort of behavior can cause the program to become unpredictable and problematic. unfortunately, i think we might just need to remove this "Invalid UTF-8" section for this example
|
Alright, I removed the Invalid UTF-8 section. |
|
thanks! @bors r+ rollup |
|
📌 Commit 8adf50d has been approved by |
Add doc examples to str::from_utf8_unchecked_mut Fixes rust-lang#44461
Add doc examples to str::from_utf8_unchecked_mut Fixes rust-lang#44461
Add doc examples to str::from_utf8_unchecked_mut Fixes rust-lang#44461
Fixes #44461