about summary refs log tree commit diff
diff options
context:
space:
mode:
authorChristopher Durham <cad97@cad97.com>2022-04-10 15:04:57 -0500
committerGitHub <noreply@github.com>2022-04-10 15:04:57 -0500
commitb92cd1a32c842e82575e59374545dda5f9b9f77a (patch)
treeffd92326255a3ba08b1933645a2cafbea208801c
parent18f32b73bdb3833c18c73fe3062bde8e1721ccca (diff)
downloadrust-b92cd1a32c842e82575e59374545dda5f9b9f77a.tar.gz
rust-b92cd1a32c842e82575e59374545dda5f9b9f77a.zip
Clarify str::from_utf8_unchecked's invariants
Specifically, make it clear that it is immediately UB to pass ill-formed UTF-8 into the function. The previous wording left space to interpret that the UB only occurred when calling another function, which "assumes that `&str`s are valid UTF-8."

This does not change whether str being UTF-8 is a safety or a validity invariant. (As per previous discussion, it is a safety invariant, not a validity invariant.) It just makes it clear that valid UTF-8 is a precondition of str::from_utf8_unchecked, and that emitting an Abstract Machine fault (e.g. UB or a sanitizer error) on invalid UTF-8 is a valid thing to do.

If user code wants to create an unsafe `&str` pointing to ill-formed UTF-8, it must be done via transmutes. Also, just, don't.
-rw-r--r--library/core/src/str/converts.rs6
1 files changed, 1 insertions, 5 deletions
diff --git a/library/core/src/str/converts.rs b/library/core/src/str/converts.rs
index ef26cbfb640..81b1db4ac6f 100644
--- a/library/core/src/str/converts.rs
+++ b/library/core/src/str/converts.rs
@@ -144,11 +144,7 @@ pub const fn from_utf8_mut(v: &mut [u8]) -> Result<&mut str, Utf8Error> {
 ///
 /// # Safety
 ///
-/// This function is unsafe because it does not check that the bytes passed to
-/// it are valid UTF-8. If this constraint is violated, undefined behavior
-/// results, as the rest of Rust assumes that [`&str`]s are valid UTF-8.
-///
-/// [`&str`]: str
+/// The bytes passed in must be valid UTF-8.
 ///
 /// # Examples
 ///