Struct tinyvec_string::arraystring::FromUtf8Error

pub struct FromUtf8Error<A: ByteArray> { /* fields omitted */ }

A possible error value when converting an ArrayString from a UTF-8 byte vector.

This type is the error type for the from_utf8 method on ArrayString. 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

use tinyvec::{array_vec, ArrayVec};
// some invalid bytes, in a vector
let bytes: ArrayVec<[u8; 2]> = array_vec![0, 159];

let value = ArrayString::from_utf8(bytes);

assert_eq!(Err(array_vec![0, 159]), value.map_err(|e| e.into_bytes()));

Implementations

impl<A: ByteArray> FromUtf8Error<A>

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

Returns a slice of u8s bytes that were attempted to convert to an ArrayString.

Examples

use tinyvec::{array_vec, ArrayVec};
// some invalid bytes, in a vector
let bytes: ArrayVec<[u8; 2]> = array_vec![0, 159];

let value = ArrayString::from_utf8(bytes);

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

pub fn into_bytes(self) -> ArrayVec<A>

Returns the bytes that were attempted to convert to a String.

Examples

use tinyvec::{array_vec, ArrayVec};
// some invalid bytes, in a vector
let bytes: ArrayVec<[u8; 2]> = array_vec![0, 159];

let value = ArrayString::from_utf8(bytes);

assert_eq!(array_vec![0, 159], value.unwrap_err().into_bytes());

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

use tinyvec::{array_vec, ArrayVec};
// some invalid bytes, in a vector
let bytes: ArrayVec<[u8; 2]> = array_vec![0, 159];

let error = ArrayString::from_utf8(bytes).unwrap_err().utf8_error();

// the first byte is invalid here
assert_eq!(1, error.valid_up_to());

Trait Implementations

impl<A: Clone + ByteArray> Clone for FromUtf8Error<A>

pub fn clone(&self) -> FromUtf8Error<A>

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<A: Copy + ByteArray> Copy for FromUtf8Error<A>

impl<A: ByteArray> Debug for FromUtf8Error<A>

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

Formats the value using the given formatter.

impl<A: ByteArray> Display for FromUtf8Error<A>

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

Formats the value using the given formatter.

impl<A: Eq + ByteArray> Eq for FromUtf8Error<A>

impl<A: ByteArray> Error for FromUtf8Error<A>

This is supported with target feature std only.

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

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

pub fn backtrace(&self) -> Option<&Backtrace>

🔬 This is a nightly-only experimental API. (backtrace)

Returns a stack backtrace, if available, of where this error occurred.

pub fn description(&self) -> &str

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

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

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

impl<A: PartialEq + ByteArray> PartialEq<FromUtf8Error<A>> for FromUtf8Error<A>

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

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

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

This method tests for !=.

impl<A: ByteArray> StructuralEq for FromUtf8Error<A>

impl<A: ByteArray> StructuralPartialEq for FromUtf8Error<A>