Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

add a panic example to std::from_utf8_unchecked #35890

Closed
wants to merge 6 commits into from
Closed

add a panic example to std::from_utf8_unchecked #35890

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3090e8e
add a panic example to std::from_utf8_unchecked
matthew-piziak Aug 22, 2016
8228b71
add `no_run` annotation to prevent doc test panic
matthew-piziak Aug 22, 2016
9db6315
show that println! causes the panic
matthew-piziak Aug 22, 2016
bd450d6
no panic happens; garbage is printed
matthew-piziak Aug 22, 2016
12ae39e
remove explicit garbage example
matthew-piziak Aug 22, 2016
2e660b6
rename `sparkle_heart` to `invalid_bytes` where bytes are invalid
matthew-piziak Aug 25, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
19 changes: 17 additions & 2 deletions src/libcore/str/mod.rs
View file
Open in desktop
Expand Up @@ -213,9 +213,9 @@ impl Utf8Error {
/// use std::str;
///
/// // some invalid bytes, in a vector
/// let sparkle_heart = vec![0, 159, 146, 150];
/// let invalid_bytes = vec![0, 159, 146, 150];
///
/// assert!(str::from_utf8(&sparkle_heart).is_err());
/// assert!(str::from_utf8(&invalid_bytes).is_err());
/// ```
///
/// See the docs for [`Utf8Error`][error] for more details on the kinds of
Expand Down Expand Up @@ -299,6 +299,21 @@ unsafe fn from_raw_parts_mut<'a>(p: *mut u8, len: usize) -> &'a mut str {
///
/// assert_eq!("💖", sparkle_heart);
/// ```
///
/// Incorrect bytes:
///
/// ```no_run
/// use std::str;
///
/// // some invalid bytes, in a vector
/// let invalid_bytes = vec![0, 159, 146, 150];
///
/// unsafe {
/// let invalid_str = str::from_utf8_unchecked(&invalid_bytes);
/// // prints unknown garbage to stdout
/// println!("{}", invalid_str);
/// }
/// ```
#[inline(always)]
#[stable(feature = "rust1", since = "1.0.0")]
pub unsafe fn from_utf8_unchecked(v: &[u8]) -> &str {
Expand Down