Enum FramingError 

pub enum FramingError {
    UnsupportedFramingVersion {
        got: u8,
        expected: u8,
    },
    FrameTooLarge {
        body_length: usize,
        cap: usize,
    },
    UnexpectedEof {
        context: &'static str,
    },
    Io(Error),
    Decode(DecodeError),
}

Errors produced by read_frame/write_frame.

The error variants are deliberately distinct from io::Error so callers can map them onto the broker’s wire-level error codes (e.g. Refused{ERROR_VERSION_UNSUPPORTED} for an FramingError::UnsupportedFramingVersion).

Variants

UnsupportedFramingVersion

Peer’s framing byte did not match ENVELOPE_VERSION.

Per #228, the v1 broker writes Refused{ERROR_VERSION_UNSUPPORTED} to the wire and closes the connection on this error.

Fields

got: u8

The framing byte the peer actually sent.

expected: u8

The framing byte we expected (always ENVELOPE_VERSION in v1).

FrameTooLarge

Body length exceeds the configured per-frame cap.

The broker disconnects on this error per the wire-level commitments in #228. Callers should not attempt to drain the peer’s payload — the socket is no longer in a known state.

Fields

body_length: usize

The length the peer claimed in the 4-byte LE header.

cap: usize

The cap the caller passed to read_frame_with_cap.

UnexpectedEof

The underlying stream closed before the full frame arrived.

Fields

context: &'static str

Which part of the frame we were reading (e.g. “framing byte”).

Io(Error)

Raw I/O error from the underlying stream.

Decode(DecodeError)

The frame body was not a valid prost Frame message.

Produced by the buffer-level try_decode_framed codec (#412); the stream-level read_frame returns raw body bytes and leaves prost decoding to the caller.

Trait Implementations

impl Debug for FramingError

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

Formats the value using the given formatter.

impl Display for FramingError

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

Formats the value using the given formatter.

impl Error for FramingError

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<DecodeError> for FramingError

fn from(source: DecodeError) -> Self

Converts to this type from the input type.

impl From<Error> for FramingError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<FramingError> for BackendHandoffWireError

fn from(source: FramingError) -> Self

Converts to this type from the input type.

impl From<FramingError> for EndpointProbeServerError

fn from(source: FramingError) -> Self

Converts to this type from the input type.

impl From<FramingError> for FrameClientError

fn from(source: FramingError) -> Self

Converts to this type from the input type.

impl From<FramingError> for MuxError

fn from(source: FramingError) -> Self

Converts to this type from the input type.

impl From<FramingError> for BrokerClientError

fn from(source: FramingError) -> Self

Converts to this type from the input type.

impl From<FramingError> for BrokerV2Error

fn from(source: FramingError) -> Self

Converts to this type from the input type.

impl From<FramingError> for AdminConnectionError

fn from(source: FramingError) -> Self

Converts to this type from the input type.

impl From<FramingError> for BrokerConnectionError

fn from(source: FramingError) -> Self

Converts to this type from the input type.

impl From<FramingError> for ControlSocketError

fn from(source: FramingError) -> Self

Converts to this type from the input type.