Enum tungstenite::error::ProtocolError

pub enum ProtocolError {
    WrongHttpMethod,
    WrongHttpVersion,
    MissingConnectionUpgradeHeader,
    MissingUpgradeWebSocketHeader,
    MissingSecWebSocketVersionHeader,
    MissingSecWebSocketKey,
    SecWebSocketAcceptKeyMismatch,
    JunkAfterRequest,
    CustomResponseSuccessful,
    HandshakeIncomplete,
    HttparseError(Error),
    SendAfterClosing,
    ReceivedAfterClosing,
    NonZeroReservedBits,
    UnmaskedFrameFromClient,
    MaskedFrameFromServer,
    FragmentedControlFrame,
    ControlFrameTooBig,
    UnknownControlFrameType(u8),
    UnknownDataFrameType(u8),
    UnexpectedContinueFrame,
    ExpectedFragment(Data),
    ResetWithoutClosingHandshake,
    InvalidOpcode(u8),
    InvalidCloseSequence,
}

Indicates the specific type/cause of a protocol error.

Variants

WrongHttpMethod

Use of the wrong HTTP method (the WebSocket protocol requires the GET method be used).

WrongHttpVersion

Wrong HTTP version used (the WebSocket protocol requires version 1.1 or higher).

MissingConnectionUpgradeHeader

Missing Connection: upgrade HTTP header.

MissingUpgradeWebSocketHeader

Missing Upgrade: websocket HTTP header.

MissingSecWebSocketVersionHeader

Missing Sec-WebSocket-Version: 13 HTTP header.

MissingSecWebSocketKey

Missing Sec-WebSocket-Key HTTP header.

SecWebSocketAcceptKeyMismatch

The Sec-WebSocket-Accept header is either not present or does not specify the correct key value.

JunkAfterRequest

Garbage data encountered after client request.

CustomResponseSuccessful

Custom responses must be unsuccessful.

HandshakeIncomplete

No more data while still performing handshake.

HttparseError(Error)

Wrapper around a httparse::Error value.

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.

UnmaskedFrameFromClient

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

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.

UnknownDataFrameType(u8)

Type of data frame not recognised.

UnexpectedContinueFrame

Received a continue frame despite there being nothing to continue.

ExpectedFragment(Data)

Received data while waiting for more fragments.

ResetWithoutClosingHandshake

Connection closed without performing the closing handshake.

InvalidOpcode(u8)

Encountered an invalid opcode.

InvalidCloseSequence

The payload for the closing frame is invalid.

Trait Implementations

impl Clone for ProtocolError

fn clone(&self) -> ProtocolError

Returns a copy of the value.

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

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any.

pub fn backtrace(&self) -> Option<&Backtrace>

🔬 This is a nightly-only experimental API. (backtrace)

Returns a stack backtrace, if available, of where this error occurred.

pub fn description(&self) -> &str

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

pub fn cause(&self) -> Option<&dyn Error>

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

impl From<Error> for ProtocolError

fn from(source: Error) -> Self

Performs the conversion.

impl PartialEq<ProtocolError> for ProtocolError

fn eq(&self, other: &ProtocolError) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ProtocolError) -> bool

This method tests for !=.

impl Copy for ProtocolError

impl Eq for ProtocolError

impl StructuralEq for ProtocolError

impl StructuralPartialEq for ProtocolError