Struct IntoStringError 

pub struct IntoStringError<const N: usize, LenT = usize>
where
    LenT: LenType,
{ /* private fields */ }

An error indicating invalid UTF-8 when converting a CString into a String.

This struct is created by CString::into_string().

Equivalent of std::ffi::IntoStringError.

Call Self::into_cstring to regain ownership of the CString.

Examples

use heapless::CString;
use heapless::c_string::IntoStringError;

// the byte slice contains invalid UTF-8
let hello_world = CString::<16>::from_bytes_with_nul(b"Hello \xF0\x90\x80World\0").unwrap();
let hello_world_clone = hello_world.clone();

let err: IntoStringError<16> = hello_world.into_string().unwrap_err();

assert_eq!(err.utf8_error().valid_up_to(), 6);
assert_eq!(err.utf8_error().error_len(), Some(3));
assert_eq!(err.into_cstring(), hello_world_clone);

Implementations

impl<const N: usize, LenT: LenType> IntoStringError<N, LenT>

pub fn into_cstring(self) -> CString<N, LenT>

Consumes this error, returning original CString which generated the error.

pub fn utf8_error(&self) -> Utf8Error

Access the underlying UTF-8 error that was the cause of this error.

Trait Implementations

impl<const N: usize, LenT> Clone for IntoStringError<N, LenT>

where LenT: LenType + Clone,

fn clone(&self) -> IntoStringError<N, LenT>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const N: usize, LenT> Debug for IntoStringError<N, LenT>

where LenT: LenType + Debug,

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

Formats the value using the given formatter.

impl<const N: usize, LenT: LenType> Display for IntoStringError<N, LenT>

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

Formats the value using the given formatter.

impl<const N: usize, LenT: LenType> Error for IntoStringError<N, LenT>

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, LenT> PartialEq for IntoStringError<N, LenT>

where LenT: LenType + PartialEq,

fn eq(&self, other: &IntoStringError<N, LenT>) -> 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, LenT> StructuralPartialEq for IntoStringError<N, LenT>

where LenT: LenType,