Enum ProtocolError 

pub enum ProtocolError {
    Utf8(BoxError),
    Io(Error),
    InvalidOpcode(u8),
    InvalidCloseSequence,
    MessageTooLong {
        size: usize,
        max_size: usize,
    },
    UnmaskedFrameFromClient,
    WriteBufferFull(Message),
    SendAfterClosing,
    ReceivedAfterClosing,
    NonZeroReservedBits,
    MaskedFrameFromServer,
    FragmentedControlFrame,
    ControlFrameTooBig,
    UnknownControlFrameType(u8),
    ResetWithoutClosingHandshake,
    UnexpectedContinueFrame,
    ExpectedFragment(OpCodeData),
    UnknownDataFrameType(u8),
    DeflateError(BoxError),
}

Indicates the specific type/cause of a protocol error.

Variants

Utf8(BoxError)

a utf-8 decode error

Io(Error)

Input-output error.

These are generally errors with the underlying connection and you should probably consider them fatal.

InvalidOpcode(u8)

Encountered an invalid opcode.

InvalidCloseSequence

The payload for the closing frame is invalid.

MessageTooLong

Received header is too long.

Message is bigger than the maximum allowed size.

Fields

size: usize

The size of the message.

For permessage-deflate messages rejected mid-inflation this is a lower-bound sentinel (max_size + 1) rather than the exact decoded length: inflation is aborted once the cap is exceeded, so the true size is never computed.

max_size: usize

The maximum allowed message size.

UnmaskedFrameFromClient

The server must close the connection when an unmasked frame is received.

WriteBufferFull(Message)

Message write buffer is full.

SendAfterClosing

Not allowed to send after having sent a closing frame.

ReceivedAfterClosing

Remote sent data after sending a closing frame.

NonZeroReservedBits

Reserved bits in frame header are non-zero.

MaskedFrameFromServer

The client must close the connection when a masked frame is received.

FragmentedControlFrame

Control frames must not be fragmented.

ControlFrameTooBig

Control frames must have a payload of 125 bytes or less.

UnknownControlFrameType(u8)

Type of control frame not recognised.

ResetWithoutClosingHandshake

Connection closed without performing the closing handshake.

UnexpectedContinueFrame

Received a continue frame despite there being nothing to continue.

ExpectedFragment(OpCodeData)

Received data while waiting for more fragments.

UnknownDataFrameType(u8)

Type of data frame not recognised.

DeflateError(BoxError)

Error while applying the deflate extension

Implementations

impl ProtocolError

pub fn is_connection_error(&self) -> bool

Check if the error is a connection error, in which case the error can be ignored.

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<DecodeError<'_>> for ProtocolError

fn from(value: DecodeError<'_>) -> 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.

impl From<Utf8Error> for ProtocolError

fn from(value: Utf8Error) -> Self

Converts to this type from the input type.