Struct DecodeError 

pub struct DecodeError {
    pub offset: usize,
    pub length: usize,
    pub kind: DecodeErrorKind,
}

An error reported by Decoder::decode_to_string.

All positional information (offset, length) is expressed in bytes and is relative to the input slice passed to the specific decode_to_string call that returned this error — not to the logical start of the overall byte stream. A caller tracking a running total offset across chunks should add the sum of the lengths of all previously-consumed chunks to offset to obtain a stream-relative position.

When the malformed data spans a chunk boundary (part of it was buffered internally from a previous call), offset is clamped to 0: the problem became visible only once the new bytes arrived, so 0 is the most useful position a caller can act on (for example, to slice input[..0] off before the error and report the rest as unconsumed).

Fields

offset: usize

Byte offset within the input slice of the call that failed.

length: usize

The number of bytes that make up the malformed/incomplete unit, where known. This is a hint for error-recovery strategies (e.g. “skip length bytes and retry”); it may be 0 when no specific byte range is at fault (e.g. an unpaired surrogate detected only once a following code unit failed to complete the pair).

kind: DecodeErrorKind

What kind of problem was found.

Trait Implementations

impl Clone for DecodeError

fn clone(&self) -> DecodeError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for DecodeError

impl Debug for DecodeError

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

Formats the value using the given formatter.

impl Display for DecodeError

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

Formats the value using the given formatter.

impl Eq for DecodeError

impl Error for DecodeError

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 DecodeError

fn eq(&self, other: &DecodeError) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for DecodeError