Enum SerialError 

#[non_exhaustive]
pub enum SerialError {
    UnexpectedEof {
        needed: usize,
        remaining: usize,
    },
    InvalidLength {
        declared: u64,
        remaining: usize,
    },
    VarintOverflow,
    IntegerOutOfRange,
    InvalidBool {
        byte: u8,
    },
    InvalidUtf8,
    InvalidTag {
        kind: &'static str,
        tag: u8,
    },
    TrailingBytes {
        remaining: usize,
    },
    Io {
        kind: ErrorKind,
        message: String,
    },
}

Every error returned by the codec.

#[non_exhaustive] so additional variants can be added in a MINOR release without breaking downstream match arms. Callers MUST include a wildcard arm.

Examples

use pack_io::{decode, SerialError};

// A length prefix that runs off the end of the buffer is rejected, not
// accepted-and-corrected.
let bad: &[u8] = &[0xff, 0xff, 0xff, 0xff, 0x0f]; // varint = u32::MAX
match decode::<String>(bad) {
    Ok(_) => unreachable!("hostile length should not decode"),
    Err(SerialError::InvalidLength { .. })
    | Err(SerialError::UnexpectedEof { .. }) => {} // expected
    Err(other) => panic!("unexpected error variant: {other}"),
}

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

The decoder needed more bytes than the input contained.

needed is the number of additional bytes the codec required to make progress; remaining is what was actually left in the buffer.

Fields

needed: usize

Number of bytes the codec required to make progress.

remaining: usize

Number of bytes still available in the input when the read failed.

InvalidLength

A length prefix declared a value larger than the buffer can hold.

This is the primary defence against a hostile length-prefix attack: the decoder refuses to allocate or read past the available input.

Fields

declared: u64

The length declared by the prefix, in bytes.

remaining: usize

Bytes remaining in the input when the prefix was read.

VarintOverflow

A LEB128 varint exceeded the maximum legal byte count for its target width (10 bytes for u64, 5 for u32, 19 for u128, etc.).

IntegerOutOfRange

A decoded varint did not fit in the requested integer width (e.g. u64 decoded successfully but the target was u32).

InvalidBool

A boolean byte was neither 0x00 nor 0x01.

Fields

byte: u8

The offending byte. Kept so the caller can log a sanitised summary ({:02x}) without echoing the surrounding payload.

InvalidUtf8

A length-prefixed byte run was not valid UTF-8 when decoding a String.

InvalidTag

A tag byte for Option (0x00 / 0x01) or Result (0x00 / 0x01) was outside the legal range.

Fields

kind: &'static str

Name of the type that owns this tag ("Option", "Result").

tag: u8

The offending tag byte.

TrailingBytes

The input buffer contained trailing bytes after a strict decode completed. Returned only by crate::decode, which requires the payload to be fully consumed.

Fields

remaining: usize

Number of bytes left over after the value was decoded.

Io

Available on crate feature std only.

An underlying std::io::Write / std::io::Read operation failed while a streaming codec was in flight. Returned only by the std-gated I/O integration (IoEncoder, IoDecoder, encode_into, decode_from).

The error kind and a stringified message are captured so the variant remains Clone + Eq. The original std::io::Error is not preserved — log the captured message field for diagnostics.

Fields

kind: ErrorKind

Classification of the underlying I/O failure.

message: String

Human-readable rendering of the original std::io::Error.

Trait Implementations

impl Clone for SerialError

fn clone(&self) -> SerialError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SerialError

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

Formats the value using the given formatter.

impl Display for SerialError

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

Formats the value using the given formatter.

impl Error for SerialError

Available on crate feature std only.

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 SerialError

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

impl StructuralPartialEq for SerialError