Struct std::string::FromUtf8Error
1.0.0 · source · pub struct FromUtf8Error { /* private fields */ }
Expand description
A possible error value when converting a String
from a UTF-8 byte vector.
This type is the error type for the from_utf8
method on String
. It
is designed in such a way to carefully avoid reallocations: the
into_bytes
method will give back the byte vector that was used in the
conversion attempt.
The Utf8Error
type provided by std::str
represents an error that may
occur when converting a slice of u8
s to a &str
. In this sense, it’s
an analogue to FromUtf8Error
, and you can get one from a FromUtf8Error
through the utf8_error
method.
§Examples
// some invalid bytes, in a vector
let bytes = vec![0, 159];
let value = String::from_utf8(bytes);
assert!(value.is_err());
assert_eq!(vec![0, 159], value.unwrap_err().into_bytes());
RunImplementations§
source§impl FromUtf8Error
impl FromUtf8Error
sourcepub fn into_bytes(self) -> Vec<u8> ⓘ
pub fn into_bytes(self) -> Vec<u8> ⓘ
Returns the bytes that were attempted to convert to a String
.
This method is carefully constructed to avoid allocation. It will consume the error, moving out the bytes, so that a copy of the bytes does not need to be made.
§Examples
// some invalid bytes, in a vector
let bytes = vec![0, 159];
let value = String::from_utf8(bytes);
assert_eq!(vec![0, 159], value.unwrap_err().into_bytes());
Runsourcepub fn utf8_error(&self) -> Utf8Error
pub fn utf8_error(&self) -> Utf8Error
Fetch a Utf8Error
to get more details about the conversion failure.
The Utf8Error
type provided by std::str
represents an error that may
occur when converting a slice of u8
s to a &str
. In this sense, it’s
an analogue to FromUtf8Error
. See its documentation for more details
on using it.
§Examples
// some invalid bytes, in a vector
let bytes = vec![0, 159];
let error = String::from_utf8(bytes).unwrap_err().utf8_error();
// the first byte is invalid here
assert_eq!(1, error.valid_up_to());
RunTrait Implementations§
source§impl Clone for FromUtf8Error
impl Clone for FromUtf8Error
source§fn clone(&self) -> FromUtf8Error
fn clone(&self) -> FromUtf8Error
source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for FromUtf8Error
impl Debug for FromUtf8Error
source§impl Display for FromUtf8Error
impl Display for FromUtf8Error
source§impl Error for FromUtf8Error
impl Error for FromUtf8Error
source§fn description(&self) -> &str
fn description(&self) -> &str
1.30.0 · source§fn source(&self) -> Option<&(dyn Error + 'static)>
fn source(&self) -> Option<&(dyn Error + 'static)>
source§impl PartialEq for FromUtf8Error
impl PartialEq for FromUtf8Error
source§fn eq(&self, other: &FromUtf8Error) -> bool
fn eq(&self, other: &FromUtf8Error) -> bool
self
and other
values to be equal, and is used
by ==
.