Struct strchunk::ExtractUtf8Error

pub struct ExtractUtf8Error { /* fields omitted */ }

An error returned by StrChunk::extract_utf8.

ExtractUtf8Error indicates an invalid UTF-8 sequence encountered in the input and provides information necessary for lossy recovery of an incremental UTF-8 decoding stream.

Example

const TEST_DATA: &[u8] = b"Hello \xF0\x90\x80World";
let mut input = BytesMut::from(TEST_DATA);
let err = StrChunk::extract_utf8(&mut input).unwrap_err();
input.advance(err.error_len());
let chunk1 = err.into_extracted();
assert_eq!(chunk1, "Hello ");
// Can inject a replacement character into the output, e.g. U+FFFD
let chunk2 = StrChunk::extract_utf8(&mut input).unwrap();
assert_eq!(chunk2, "World");

Implementations

impl ExtractUtf8Error

pub fn error_len(&self) -> usize

Length of the invalid byte sequence. A lossy decoding procedure should advance the reading position by the returned amount using the advance method of the input buffer to resume decoding.

pub fn into_extracted(self) -> StrChunk

Consumes self to obtain the string content extracted up to the encountered invalid sequence.

Trait Implementations

impl Clone for ExtractUtf8Error

fn clone(&self) -> ExtractUtf8Error

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ExtractUtf8Error

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

Formats the value using the given formatter.

impl Display for ExtractUtf8Error

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

Formats the value using the given formatter.

impl Error for ExtractUtf8Error

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

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

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

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

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

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