Enum ProtocolError 

pub enum ProtocolError {
    IncompleteHeader {
        message: Option<String>,
    },
    TruncatedPayload {
        message: Option<String>,
    },
    UnknownFrameType {
        type_id: u8,
        message: Option<String>,
    },
    InvalidStream {
        frame_type: FrameType,
        stream_id: u32,
        message: Option<String>,
    },
    InvalidStateTransition {
        current_state: ConnectionState,
        frame_type: FrameType,
        message: Option<String>,
    },
    AuthenticationFailure {
        message: Option<String>,
    },
    VersionMismatch {
        message: Option<String>,
    },
    SchemaIncompatible {
        message: Option<String>,
    },
    CodecError {
        message: Option<String>,
    },
}

Protocol-level failures with stable numeric reason codes for error frames and metrics.

Variants

IncompleteHeader

A frame header did not contain all fixed-size header bytes.

Fields

message: Option<String>

TruncatedPayload

A frame header declared more payload bytes than were present.

Fields

message: Option<String>

UnknownFrameType

An unknown frame type was observed for logging or metrics.

Fields

type_id: u8

message: Option<String>

InvalidStream

A frame appeared on a stream that is invalid for its type.

Fields

frame_type: FrameType

stream_id: u32

message: Option<String>

InvalidStateTransition

A frame would move the protocol connection through an invalid state transition.

Fields

current_state: ConnectionState

frame_type: FrameType

message: Option<String>

AuthenticationFailure

Authentication failed during connection setup.

Fields

message: Option<String>

VersionMismatch

The peers could not agree on a compatible protocol version.

Fields

message: Option<String>

SchemaIncompatible

A requested schema is incompatible with this connection or stream.

Fields

message: Option<String>

CodecError

Bytes could not be encoded or decoded according to the frame format.

Fields

message: Option<String>

Implementations

impl ProtocolError

pub const INCOMPLETE_HEADER_CODE: u16 = 0x0001

Malformed header reason code.

pub const TRUNCATED_PAYLOAD_CODE: u16 = 0x0002

Truncated payload reason code.

pub const UNKNOWN_FRAME_TYPE_CODE: u16 = 0x0003

Unknown frame type reason code.

pub const INVALID_STREAM_CODE: u16 = 0x0004

Invalid stream reason code.

pub const INVALID_STATE_TRANSITION_CODE: u16 = 0x0005

Invalid state transition reason code.

pub const AUTHENTICATION_FAILURE_CODE: u16 = 0x0006

Authentication failure reason code.

pub const VERSION_MISMATCH_CODE: u16 = 0x0007

Version mismatch reason code.

pub const SCHEMA_INCOMPATIBLE_CODE: u16 = 0x0008

Schema incompatibility reason code.

pub const CODEC_ERROR_CODE: u16 = 0x0009

Codec error reason code.

pub const fn reason_code(&self) -> u16

Return the stable numeric reason code for this error.

pub fn message(&self) -> Option<&str>

Return the optional human-readable message carried by this error.

Trait Implementations

impl Clone for ProtocolError

fn clone(&self) -> ProtocolError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

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

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