Enum ProtocolError 

pub enum ProtocolError {
    Io(Error),
    FrameTooLarge {
        actual: usize,
        maximum: usize,
    },
    UnsupportedVersion(u8),
    InvalidMagic,
    UnknownFrameKind(u8),
    UnknownEnum {
        name: &'static str,
        value: u8,
    },
    Truncated(&'static str),
    InvalidUtf8(&'static str),
    InvalidDestination,
    FieldTooLong {
        field: &'static str,
        actual: usize,
        maximum: usize,
    },
    TrailingBytes(usize),
    LengthOverflow,
}

Failures raised while encoding or decoding an SDK–Gateway frame.

Variants

Io(Error)

The underlying transport failed while a frame was being read or written.

FrameTooLarge

A frame payload is longer than the codec’s configured maximum.

Fields

actual: usize

Payload length seen on the wire, in bytes.

maximum: usize

Configured payload limit, in bytes.

UnsupportedVersion(u8)

The frame header names a protocol version this codec does not implement.

InvalidMagic

The frame header does not begin with the expected magic bytes.

UnknownFrameKind(u8)

The header kind byte does not name a frame in this protocol version.

UnknownEnum

A byte-valued enum field carries a value outside the contract.

Fields

name: &'static str

Name of the enum type that rejected the value.

value: u8

The wire byte that matched no variant.

Truncated(&'static str)

The payload ended before the named field was complete.

InvalidUtf8(&'static str)

The named string field is not valid UTF-8.

InvalidDestination

The decoded namespace and name do not form a valid Destination.

FieldTooLong

A length-prefixed field is longer than the wire format allows.

Fields

field: &'static str

Name of the field that exceeded its limit.

actual: usize

Length of the offered value, in bytes.

maximum: usize

Largest length the field accepts, in bytes.

TrailingBytes(usize)

The payload held bytes left over after the frame was decoded.

LengthOverflow

A frame length cannot be represented on the wire, or a decode offset would overflow.

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, __formatter: &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(source: Error) -> Self

Converts to this type from the input type.