Struct FromUtf8Error

pub struct FromUtf8Error<const N: usize> { /* private fields */ }

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

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

Examples

use stack_buf::{StackStr, stack_vec};

// some invalid bytes, in a vector
let bytes = stack_vec![0, 159];

let value = StackStr::<2>::from_utf8(bytes);

assert!(value.is_err());
assert_eq!(stack_vec![0, 159], value.unwrap_err().into_bytes());

Implementations

impl<const N: usize> FromUtf8Error<N>

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

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

Examples

use stack_buf::{StackStr, stack_vec};

// some invalid bytes, in a vector
let bytes = stack_vec![0, 159];

let value = StackStr::<2>::from_utf8(bytes);

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

pub fn into_bytes(self) -> StackVec<u8, N>

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

Examples

use stack_buf::{stack_vec, StackStr};

// some invalid bytes, in a vector
let bytes = stack_vec![0, 159];

let value = StackStr::<2>::from_utf8(bytes);

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

pub const fn utf8_error(&self) -> Utf8Error

Fetch a Utf8Error to get more details about the conversion failure.

Examples

use stack_buf::{StackStr, stack_vec};

// some invalid bytes, in a vector
let bytes = stack_vec![0, 159];

let error = StackStr::<2>::from_utf8(bytes).unwrap_err().utf8_error();

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

Trait Implementations

impl<const N: usize> Clone for FromUtf8Error<N>

fn clone(&self) -> FromUtf8Error<N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const N: usize> Debug for FromUtf8Error<N>

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

Formats the value using the given formatter.

impl<const N: usize> Display for FromUtf8Error<N>

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

Formats the value using the given formatter.

impl<const N: usize> Error for FromUtf8Error<N>

Available on crate features std and str only.

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

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

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

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

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

Provides type-based access to context intended for error reports.

impl<const N: usize> PartialEq for FromUtf8Error<N>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<const N: usize> Eq for FromUtf8Error<N>

impl<const N: usize> StructuralPartialEq for FromUtf8Error<N>