Enum ProtocolError 

#[non_exhaustive]
pub enum ProtocolError {
    Io(Error),
    Json(Error),
    FrameTooLarge {
        len: u32,
        max: u32,
    },
    VersionMismatch {
        expected: u16,
        actual: u16,
    },
}

Failure modes the codec can produce while reading or writing a frame.

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.

Io(Error)

Underlying I/O failure (pipe closed, partial read, etc.).

Json(Error)

JSON serialisation or deserialisation failure.

FrameTooLarge

A frame body exceeded MAX_FRAME_BYTES.

Fields

len: u32

Observed frame size in bytes.

max: u32

Maximum allowed frame size.

VersionMismatch

Peer’s frame version did not match this binary’s PROTOCOL_VERSION.

Fields

expected: u16

Version this binary expected.

actual: u16

Version the peer used.

Implementations

impl ProtocolError

pub fn is_eof(&self) -> bool

Whether the underlying I/O error indicates the peer’s pipe was closed (UnexpectedEof). Used by callers to distinguish a clean fatal exit from a true protocol failure.

Trait Implementations

impl Debug for ProtocolError

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

Formats the value using the given formatter.

impl Display for ProtocolError

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

Formats the value using the given formatter.

impl Error for ProtocolError

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<Error> for ProtocolError

fn from(value: Error) -> Self

Converts to this type from the input type.

impl From<Error> for ProtocolError

fn from(value: Error) -> Self

Converts to this type from the input type.