Struct Leb128DecodeError 

pub struct Leb128DecodeError { /* private fields */ }

Error reported while decoding a LEB128 integer from a byte buffer.

Implementations

impl Leb128DecodeError

pub const fn incomplete( start_index: usize, required: NonZeroUsize, available: usize, ) -> Self

Creates an incomplete-input decoding error.

Parameters

• start_index: Byte index where the incomplete value starts.
• required: Non-zero lower bound for total bytes that must be readable from start_index before decoding can make progress.
• available: Bytes currently available from start_index.

Returns

Returns an error carrying incomplete-input context.

Panics

Panics when required <= available, or when the one-past-available error boundary overflows usize.

pub const fn malformed( start_index: usize, error_index: usize, consumed: NonZeroUsize, ) -> Self

Creates a malformed-input decoding error.

Parameters

• start_index: Byte index where the malformed value starts.
• error_index: Byte index at which the malformed input was detected.
• consumed: Non-zero bytes the caller may consume to make progress.

Returns

Returns an error carrying malformed-input context.

Panics

Panics when error_index is outside the consumed span.

pub const fn noncanonical(start_index: usize, consumed: NonZeroUsize) -> Self

Creates a non-canonical-input decoding error.

Parameters

• start_index: Byte index where the non-canonical value starts.
• consumed: Non-zero bytes the caller may consume to make progress.

Returns

Returns an error carrying non-canonical-input context.

Panics

Panics when the last consumed byte index overflows usize.

pub const fn kind(self) -> Leb128DecodeErrorKind

Returns the decoding error kind.

pub const fn start_index(self) -> usize

Returns the absolute byte index where the attempted value starts.

pub const fn error_index(self) -> usize

Returns the absolute byte index where the error was detected.

Returns

Returns the byte index that made the error observable. For incomplete input this is the one-past-available boundary where the next byte would be required, so it may be equal to the input length visible to the caller.

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

Returns bytes that may be consumed after an invalid-input error.

Returns

Returns Some(consumed) for invalid input, or None for incomplete input.

pub const fn is_incomplete(self) -> bool

Returns whether this error reports an incomplete input prefix.

pub const fn is_malformed(self) -> bool

Returns whether this error reports malformed input.

pub const fn is_noncanonical(self) -> bool

Returns whether this error reports a non-canonical representation.

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

Returns a lower bound for bytes required to continue incomplete decoding.

Returns

Returns Some(required) for incomplete input, or None otherwise. The returned value is a non-zero lower bound for the total readable bytes required from Self::start_index before decoding can make progress; it does not guarantee that the value will be complete at exactly that length.

pub const fn additional(self) -> Option<NonZeroUsize>

Returns additional bytes required to continue incomplete decoding.

Returns

Returns Some(additional) for incomplete input, or None otherwise. The value is required - available and is guaranteed to be non-zero.

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

Returns bytes available for an incomplete value.

Returns

Returns Some(available) for incomplete input, or None otherwise.

Trait Implementations

impl Clone for Leb128DecodeError

fn clone(&self) -> Leb128DecodeError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Leb128DecodeError

impl Debug for Leb128DecodeError

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

Formats the value using the given formatter.

impl Display for Leb128DecodeError

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

Formats the value using the given formatter.

impl Eq for Leb128DecodeError

impl Error for Leb128DecodeError

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 Leb128DecodeError

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