Enum FrameError 

pub enum FrameError {
    BadMagic,
    BadVersion {
        got: u8,
        expected: u8,
    },
    BadHeaderCrc,
    BadPayloadCrc,
    OversizePayload {
        len: u32,
        max: u32,
    },
    ReservedNonZero,
    Truncated {
        have: usize,
        need: usize,
    },
}

Errors raised while decoding a frame off the wire. Each maps to a wire protocol-error condition; a mismatch is fail-stop for the connection (a corrupt frame desynchronizes the byte stream).

Variants

BadMagic

First four bytes were not b"BRN0".

BadVersion

Version byte did not match WIRE_VERSION.

Fields

got: u8

expected: u8

BadHeaderCrc

header_crc32c did not match the recomputed CRC.

BadPayloadCrc

payload_crc32c did not match the CRC of the payload bytes.

OversizePayload

payload_len exceeded the negotiated maximum — rejected before any payload buffer is reserved, so a hostile length can’t force a large allocation.

Fields

len: u32

max: u32

ReservedNonZero

A reserved header byte or reserved flag bit was non-zero.

Truncated

Not enough bytes buffered yet to decode the frame; caller should read more from the socket and retry.

Fields

have: usize

need: usize

Trait Implementations

impl Debug for FrameError

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

Formats the value using the given formatter.

impl Display for FrameError

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

Formats the value using the given formatter.

impl Eq for FrameError

impl Error for FrameError

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 From<FrameError> for BrainError

fn from(source: FrameError) -> Self

Converts to this type from the input type.

impl PartialEq for FrameError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for FrameError