Enum CharsetDecodeErrorKind 

pub enum CharsetDecodeErrorKind {
    MalformedSequence {
        value: Option<u32>,
    },
    InvalidInputIndex {
        input_len: usize,
    },
    InvalidOutputIndex {
        output_len: usize,
    },
    IncompleteSequence {
        required: usize,
        available: usize,
    },
    InvalidCodePoint {
        value: u32,
    },
}

Classifies failures detected while decoding encoded units into Unicode text.

Variants

MalformedSequence

The input units do not form a well-formed encoded sequence.

Fields

value: Option<u32>

Optional malformed raw value captured from the offending input unit.

InvalidInputIndex

The requested input unit index is outside the input buffer.

Fields

input_len: usize

Length of the input provided to the codec call.

InvalidOutputIndex

The requested output character index is outside the output buffer.

Fields

output_len: usize

Length of the output provided to the codec call.

IncompleteSequence

The closed input ended before a complete character was available.

Fields

required: usize

Total units required to complete the current sequence.

available: usize

Total units currently available from the start of the current sequence.

InvalidCodePoint

The decoded numeric value is not a valid Unicode scalar value.

Fields

value: u32

Raw decoded code-point value.

Implementations

impl CharsetDecodeErrorKind

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

Returns the number of required input units for this kind, if available.

Returns

• Some(required) for Self::IncompleteSequence;
• None for all other variants.

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

Returns the number of currently available input units for this kind, if available.

Returns

• Some(available) for Self::IncompleteSequence;
• None for all other variants.

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

Returns the raw malformed value associated with this decoding error, if any.

Returns

• Some(value) for Self::MalformedSequence when a specific malformed unit value is available.
• Some(value) for Self::InvalidCodePoint.
• None for other variants.

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

Returns the input length when this error comes from an invalid input index.

Returns

• Some(input_len) for Self::InvalidInputIndex;
• None for other variants.

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

Returns the output length when this error comes from an invalid output index.

Returns

• Some(output_len) for Self::InvalidOutputIndex;
• None for other variants.

pub const fn is_incomplete(self) -> bool

Returns whether this kind represents incomplete input.

Returns

Returns true for Self::IncompleteSequence.

pub const fn incomplete(self) -> Option<(usize, usize)>

Returns incomplete-input details for this kind.

Returns

Returns Some((required, available)) for Self::IncompleteSequence, or None for all other variants.

pub const fn is_malformed_input(self) -> bool

Returns whether this kind represents malformed encoded input.

Returns

Returns true for malformed sequences and invalid decoded scalar values. Incomplete input is caller-owned tail data and is not treated as malformed input by buffered charset decoders.

Trait Implementations

impl Clone for CharsetDecodeErrorKind

fn clone(&self) -> CharsetDecodeErrorKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CharsetDecodeErrorKind

impl Debug for CharsetDecodeErrorKind

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

Formats the value using the given formatter.

impl Display for CharsetDecodeErrorKind

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

Formats the value using the given formatter.

impl Eq for CharsetDecodeErrorKind

impl Error for CharsetDecodeErrorKind

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 PartialEq for CharsetDecodeErrorKind

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