Struct CharsetDecodeError 

pub struct CharsetDecodeError { /* private fields */ }

Error reported by a charset decoder.

The error always carries the charset, error kind, and input unit index at which the failure was detected. Errors that decode a raw numeric value, such as invalid UTF-32 units, carry that value through Self::kind and Self::value. Invalid-input errors may also carry a consumed-unit count so buffered decoders can make progress without an extra status wrapper.

Implementations

impl CharsetDecodeError

pub const fn new( charset: Charset, kind: CharsetDecodeErrorKind, index: usize, ) -> Self

Creates a decoding error.

Parameters

• charset: The charset being decoded.
• kind: The failure category.
• index: The input unit index where the failure was detected.

Returns

Returns a decoding error carrying the supplied context.

pub const fn with_consumed(self, consumed: usize) -> Self

Returns a copy of this error with invalid-input consumption context.

Parameters

• consumed: Number of units that may be consumed to make progress.

Returns

Returns this error carrying the supplied consumption count.

pub const fn charset(self) -> Charset

Returns the charset being decoded.

Returns

Returns the stored Charset.

pub const fn kind(self) -> CharsetDecodeErrorKind

Returns the decoding error kind.

Returns

Returns the stored CharsetDecodeErrorKind.

pub const fn index(self) -> usize

Returns the input unit index associated with this error.

Returns

Returns the index at which the error was detected.

pub const fn required(self) -> Option<usize>

Returns required input units for this decoding error, if reported.

Returns

Returns Some(required) for CharsetDecodeErrorKind::IncompleteSequence, otherwise None.

pub const fn available(self) -> Option<usize>

Returns available input units for this decoding error, if reported.

Returns

Returns Some(available) for CharsetDecodeErrorKind::IncompleteSequence, otherwise None.

pub const fn input_len(self) -> Option<usize>

Returns input length for this decoding error, if reported.

Returns

Returns Some(input_len) for CharsetDecodeErrorKind::InvalidInputIndex, otherwise None.

pub const fn output_len(self) -> Option<usize>

Returns output length for this decoding error, if reported.

Returns

Returns Some(output_len) for CharsetDecodeErrorKind::InvalidOutputIndex, otherwise None.

pub const fn value(self) -> Option<u32>

Returns the raw value associated with this error.

Returns

Returns Some(value) when the error kind carries a raw unit or code point value, or None for kinds without an associated value.

pub const fn consumed(self) -> Option<usize>

Returns units that may be consumed after this invalid-input error.

Returns

Returns Some(consumed) for malformed and invalid-code-point input, or None for incomplete input and invalid caller indexes.

pub const fn offset_by(self, base: usize) -> Self

Offsets this error by a base unit index.

Parameters

• base: The base index to add to the stored index.

Returns

Returns a copy of this error with its index shifted by base.

If the shifted index cannot be represented, it is saturated to usize::MAX.

Trait Implementations

impl Clone for CharsetDecodeError

fn clone(&self) -> CharsetDecodeError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CharsetDecodeError

impl Debug for CharsetDecodeError

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

Formats the value using the given formatter.

impl Display for CharsetDecodeError

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

Formats this decoding error.

Parameters

• formatter: The formatter receiving the diagnostic message.

Errors

Returns any formatting error reported by formatter.

impl Eq for CharsetDecodeError

impl Error for CharsetDecodeError

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 From<CharsetDecodeError> for CharsetConvertError

fn from(source: CharsetDecodeError) -> Self

Converts to this type from the input type.

impl PartialEq for CharsetDecodeError

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