Struct utf16string::Utf16Error

pub struct Utf16Error { /* fields omitted */ }

Error for invalid UTF-16 encoded bytes.

Implementations

impl Utf16Error

pub fn valid_up_to(&self) -> usize

Returns the index in given bytes up to which valid UTF-16 was verified.

pub fn error_len(&self) -> Option<usize>

Return the length of the error if it is recoverable.

• None: the end of the input was reached unexpectedly. Utf16Error::valid_up_to is 1 to 3 bytes from the end of the input. If a byte stream such as a file or a network socket is being decoded incrementally, this could still be a valid char whose byte sequence is spanning multiple chunks.

• Some(len): an unexpected byte was encountered. The length provided is that of the invalid byte sequence that starts at the index given by Utf16Error::valid_up_to. Decoding should resume after that sequence (after inserting a U+FFFD REPLACEMENT CHARACTER) in case of lossy decoding. In fact for UTF-16 the len reported here will always be exactly 2 since this never looks ahead to see if the bytes following the error sequence are valid as well as otherwise you would not know how many replacement characters to insert when writing a lossy decoder.

The semantics of this API are compatible with the semantics of Utf8Error.

Trait Implementations

impl Clone for Utf16Error

fn clone(&self) -> Utf16Error

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Utf16Error

impl Debug for Utf16Error

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

Formats the value using the given formatter.

impl Display for Utf16Error

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

Formats the value using the given formatter.

impl Error for Utf16Error

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