pub struct FromUtf8Error<'bump> { /* 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 u8s 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

Basic usage:

use bumpalo::{Bump, collections::String};

let b = Bump::new();

// some invalid bytes, in a vector
let bytes = bumpalo::vec![in &b; 0, 159];

let value = String::from_utf8(bytes);

assert!(value.is_err());
assert_eq!(bumpalo::vec![in &b; 0, 159], value.unwrap_err().into_bytes());

Implementations§

source§

impl<'bump> FromUtf8Error<'bump>

source

pub fn as_bytes(&self) -> &[u8]

Returns a slice of bytes that were attempted to convert to a String.

Examples

Basic usage:

use bumpalo::{Bump, collections::String};

let b = Bump::new();

// some invalid bytes, in a vector
let bytes = bumpalo::vec![in &b; 0, 159];

let value = String::from_utf8(bytes);

assert_eq!(&[0, 159], value.unwrap_err().as_bytes());
source

pub fn into_bytes(self) -> Vec<'bump, 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

Basic usage:

use bumpalo::{Bump, collections::String};

let b = Bump::new();

// some invalid bytes, in a vector
let bytes = bumpalo::vec![in &b; 0, 159];

let value = String::from_utf8(bytes);

assert_eq!(bumpalo::vec![in &b; 0, 159], value.unwrap_err().into_bytes());
source

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 u8s to a &str. In this sense, it’s an analogue to FromUtf8Error. See its documentation for more details on using it.

Examples

Basic usage:

use bumpalo::{Bump, collections::String};

let b = Bump::new();

// some invalid bytes, in a vector
let bytes = bumpalo::vec![in &b; 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());

Trait Implementations§

source§

impl<'bump> Debug for FromUtf8Error<'bump>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<'bump> Display for FromUtf8Error<'bump>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'bump> !RefUnwindSafe for FromUtf8Error<'bump>

§

impl<'bump> !Send for FromUtf8Error<'bump>

§

impl<'bump> !Sync for FromUtf8Error<'bump>

§

impl<'bump> Unpin for FromUtf8Error<'bump>

§

impl<'bump> !UnwindSafe for FromUtf8Error<'bump>

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToString for Twhere T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.