Enum Error 

#[non_exhaustive]
pub enum Error {
    UnexpectedEof,
    BufferFull,
    VarintOverflow,
    FrameTooLarge {
        len: usize,
        limit: usize,
    },
    InvalidLengthPrefix,
    DelimiterNotFound,
    InvalidEncoding,
    BitOverflow,
    EmptyDelimiter,
}

Errors returned by codec and framing operations.

Example

use wire_codec::{Error, ReadBuf};

let mut buf = ReadBuf::new(&[0x01]);
// Only one byte available but we ask for two.
let result = buf.read_u16_be();
assert!(matches!(result, Err(Error::UnexpectedEof)));

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

Reader ran out of bytes before the requested value could be decoded.

BufferFull

Writer ran out of capacity before the requested value could be encoded.

VarintOverflow

A varint exceeded the maximum encoded length for its target width.

FrameTooLarge

A frame’s declared length exceeds the configured limit for the framer.

Fields

len: usize

Frame length advertised by the protocol.

limit: usize

Configured upper bound enforced by the framer.

InvalidLengthPrefix

A length prefix was structurally invalid (e.g. width zero, or a width larger than the codec supports).

DelimiterNotFound

A delimiter byte sequence was not found within the available input.

InvalidEncoding

Decoded data violated a structural invariant required by the codec.

BitOverflow

A bit-level write requested more bits than the target type can hold, or a value did not fit in the requested bit width.

EmptyDelimiter

A delimited-framer constructor was given an empty delimiter, which cannot uniquely separate frames.

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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 Error

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

impl Eq for Error

impl StructuralPartialEq for Error