Enum ErrorKind 

#[non_exhaustive]
pub enum ErrorKind {
    UnexpectedEof {
        needed: usize,
        remaining: usize,
    },
    Incomplete {
        needed: Option<usize>,
    },
    TrailingBytes {
        remaining: usize,
    },
    TooWide {
        width: usize,
    },
    Io(ErrorKind),
    BadMagic {
        expected: u128,
        found: u128,
    },
    Convert {
        message: String,
    },
    NotSeekable,
    BufferFull {
        cap: usize,
    },
}

The cause of a BitError. #[non_exhaustive]: new variants may be added without a major version bump, so match with a wildcard arm.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

UnexpectedEof

Ran past the end of a finite input (a slice): needed bits were requested, remaining were left. Definitive — distinct from Incomplete.

Fields

needed: usize

Bits requested.

remaining: usize

Bits still available.

Incomplete

A streaming source (StreamBitReader) ran out mid-message: the caller should read more bytes and retry. needed is a best-effort byte hint (None when unknown). See BitError::is_incomplete.

Fields

needed: Option<usize>

Best-effort estimate of additional bytes needed, if known.

TrailingBytes

decode_exact left whole bytes unconsumed after the message.

Fields

remaining: usize

Number of trailing bytes.

TooWide

A single field exceeded the 128-bit carrier width.

Fields

width: usize

The offending width.

Io(ErrorKind)

Available on crate feature std only.

An I/O error while encoding to a std::io::Write sink (the std feature).

BadMagic

A magic constant read off the wire did not match. Both values are the type-erased low-bit representations (Bits::into_bits).

Fields

expected: u128

The constant the codec expected.

found: u128

The value actually read.

Convert

A try_map conversion from the wire representation failed; message is the converter’s Display output.

Fields

message: String

The converter’s error, rendered.

NotSeekable

A position directive (restore_position/seek) ran on a non-seekable Source (a forward-only stream). Decode from a slice (BitReader) or a seekable source instead.

BufferFull

A BufSource hit its retention cap before the message finished — the framed message is larger than the configured bound (never unbounded).

Fields

cap: usize

The cap, in bytes.

Trait Implementations

impl Clone for ErrorKind

fn clone(&self) -> ErrorKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ErrorKind

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

Formats the value using the given formatter.

impl Eq for ErrorKind

impl PartialEq for ErrorKind

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ErrorKind