Struct bstr::FromUtf8Error

pub struct FromUtf8Error { /* fields omitted */ }

An error that may occur when converting a Vec<u8> to a String.

This error includes the original Vec<u8> that failed to convert to a String. This permits callers to recover the allocation used even if it it not valid UTF-8.

Examples

Basic usage:

use bstr::{B, ByteVec};

let bytes = Vec::from_slice(b"foo\xFFbar");
let err = bytes.into_string().unwrap_err();

assert_eq!(err.utf8_error().valid_up_to(), 3);
assert_eq!(err.utf8_error().error_len(), Some(1));

// At no point in this example is an allocation performed.
let bytes = Vec::from(err.into_vec());
assert_eq!(bytes, B(b"foo\xFFbar"));

Methods

impl FromUtf8Error

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

Return the original bytes as a slice that failed to convert to a String.

Examples

Basic usage:

use bstr::{B, ByteVec};

let bytes = Vec::from_slice(b"foo\xFFbar");
let err = bytes.into_string().unwrap_err();

// At no point in this example is an allocation performed.
assert_eq!(err.as_bytes(), B(b"foo\xFFbar"));

pub fn into_vec(self) -> Vec<u8>

Consume this error and return the original byte string that failed to convert to a String.

Examples

Basic usage:

use bstr::{B, ByteVec};

let bytes = Vec::from_slice(b"foo\xFFbar");
let err = bytes.into_string().unwrap_err();
let original = err.into_vec();

// At no point in this example is an allocation performed.
assert_eq!(original, B(b"foo\xFFbar"));

pub fn utf8_error(&self) -> &Utf8Error

Return the underlying UTF-8 error that occurred. This error provides information on the nature and location of the invalid UTF-8 detected.

Examples

Basic usage:

use bstr::{B, ByteVec};

let bytes = Vec::from_slice(b"foo\xFFbar");
let err = bytes.into_string().unwrap_err();

assert_eq!(err.utf8_error().valid_up_to(), 3);
assert_eq!(err.utf8_error().error_len(), Some(1));

Trait Implementations

impl Eq for FromUtf8Error

impl PartialEq<FromUtf8Error> for FromUtf8Error

fn eq(&self, other: &FromUtf8Error) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &FromUtf8Error) -> bool

This method tests for !=.

impl Display for FromUtf8Error

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

Formats the value using the given formatter.

impl Debug for FromUtf8Error

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

Formats the value using the given formatter.

impl Error for FromUtf8Error

fn description(&self) -> &str

This method is soft-deprecated.

fn cause(&self) -> Option<&dyn Error>

Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

The lower-level cause of this error, if any.

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any.