Enum ProtocolError 

pub enum ProtocolError {
    InvalidOpcode(u8),
    ReservedBitsSet {
        bits: u8,
    },
    MaskedFrameFromServer,
    UnmaskedFrameFromClient,
    PayloadTooLarge {
        size: u64,
        max: u64,
    },
    ControlFrameTooLarge {
        size: u64,
    },
    FragmentedControlFrame,
    InvalidCloseCode(u16),
    InvalidUtf8InCloseReason,
    CloseFrameTooShort,
    ContinuationWithoutStart,
    NewMessageDuringAssembly,
    InvalidUtf8,
    MessageTooLarge {
        accumulated: usize,
        max: usize,
    },
}

Protocol error from WebSocket frame decoding.

Each variant is a specific RFC 6455 violation. No catch-all.

Variants

InvalidOpcode(u8)

Frame header contains an unrecognized opcode.

ReservedBitsSet

Reserved bits (RSV1-3) are set without a negotiated extension.

Fields

bits: u8

The RSV bits that were set (bits 4-6 of byte 0).

MaskedFrameFromServer

Server sent a masked frame (RFC 6455 §5.1: server MUST NOT mask).

UnmaskedFrameFromClient

Client sent an unmasked frame (RFC 6455 §5.1: client MUST mask).

PayloadTooLarge

Frame payload exceeds the configured maximum frame size.

Fields

size: u64

Declared payload size.

max: u64

Configured maximum.

ControlFrameTooLarge

Control frame payload exceeds 125 bytes (RFC 6455 §5.5).

Fields

size: u64

Declared payload size.

FragmentedControlFrame

Control frame is fragmented (RFC 6455 §5.5: MUST NOT be fragmented).

InvalidCloseCode(u16)

Close frame has invalid status code.

InvalidUtf8InCloseReason

Close frame reason is not valid UTF-8.

CloseFrameTooShort

Close frame payload is 1 byte (must be 0 or >= 2).

ContinuationWithoutStart

Received a continuation frame with no preceding start frame.

NewMessageDuringAssembly

Received a new data frame (Text/Binary) while assembling fragments.

InvalidUtf8

Text message payload is not valid UTF-8.

MessageTooLarge

Assembled message exceeds the configured maximum message size.

Fields

accumulated: usize

Accumulated size so far.

max: usize

Configured maximum.

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

fn from(e: ProtocolError) -> Self

Converts to this type from the input type.

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

impl StructuralPartialEq for ProtocolError