Skip to main content

WebSocketError

Enum WebSocketError 

Source
pub enum WebSocketError {
Show 22 variants InvalidFragment, FragmentTimeout, InvalidUTF8, InvalidContinuationFrame, InvalidStatusCode(u16), InvalidUpgradeHeader, InvalidConnectionHeader, ConnectionClosed, InvalidCloseFrame, InvalidCloseCode, ReservedBitsNotZero, ControlFrameFragmented, PingFrameTooLarge, FrameTooLarge, InvalidSecWebsocketVersion, InvalidOpCode(u8), MissingSecWebSocketKey, InvalidHttpScheme, CompressionNotSupported, UrlParseError(ParseError), IoError(Error), HTTPError(Error),
}
Expand description

Errors that can occur during WebSocket operations.

Variants§

§

InvalidFragment

Available on non-WebAssembly only.

Invalid fragment sequence.

§

FragmentTimeout

Available on non-WebAssembly only.

Fragmented message timed out.

§

InvalidUTF8

Payload contains invalid UTF-8.

§

InvalidContinuationFrame

Available on non-WebAssembly only.

Continuation frame without initial frame.

§

InvalidStatusCode(u16)

Available on non-WebAssembly only.

HTTP status code not valid for WebSocket upgrade.

§

InvalidUpgradeHeader

Available on non-WebAssembly only.

Missing or invalid “Upgrade: websocket” header.

§

InvalidConnectionHeader

Available on non-WebAssembly only.

Missing or invalid “Connection: upgrade” header.

§

ConnectionClosed

Connection has been closed.

§

InvalidCloseFrame

Available on non-WebAssembly only.

Close frame has invalid format.

§

InvalidCloseCode

Available on non-WebAssembly only.

Close frame contains invalid status code.

§

ReservedBitsNotZero

Available on non-WebAssembly only.

Reserved bits in frame header are not zero.

§

ControlFrameFragmented

Available on non-WebAssembly only.

Control frame is fragmented.

§

PingFrameTooLarge

Available on non-WebAssembly only.

Ping frame exceeds 125 bytes.

§

FrameTooLarge

Available on non-WebAssembly only.

Frame payload exceeds configured maximum.

§

InvalidSecWebsocketVersion

Available on non-WebAssembly only.

Sec-WebSocket-Version is not 13.

§

InvalidOpCode(u8)

Invalid frame opcode.

§

MissingSecWebSocketKey

Available on non-WebAssembly only.

Missing Sec-WebSocket-Key header.

§

InvalidHttpScheme

URL scheme is not ws:// or wss://.

§

CompressionNotSupported

Available on non-WebAssembly only.

Received compressed frame but compression not negotiated.

§

UrlParseError(ParseError)

URL parsing error.

§

IoError(Error)

Available on non-WebAssembly only.

I/O error.

§

HTTPError(Error)

Available on non-WebAssembly only.

Hyper HTTP error.

Implementations§

Source§

impl WebSocketError

Source

pub fn is_protocol_error(&self) -> bool

Available on non-WebAssembly only.

Returns true if this is a protocol-level error (RFC 6455 violation).

Source

pub fn is_handshake_error(&self) -> bool

Available on non-WebAssembly only.

Returns true if this is a handshake error.

Source

pub fn is_closed(&self) -> bool

Returns true if the connection is closed.

Source

pub fn is_data_error(&self) -> bool

Available on non-WebAssembly only.

Returns true if this is a data validation error (invalid UTF-8 or size limit).

Source

pub fn is_io_error(&self) -> bool

Available on non-WebAssembly only.

Returns true if this wraps an I/O error.

Source

pub fn as_io_error(&self) -> Option<&Error>

Available on non-WebAssembly only.

Returns the underlying I/O error, if any.

Trait Implementations§

Source§

impl Debug for WebSocketError

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Display for WebSocketError

Source§

fn fmt(&self, __formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Error for WebSocketError

Source§

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

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

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

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

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. Read more
Source§

impl From<Error> for WebSocketError

Source§

fn from(source: Error) -> Self

Converts to this type from the input type.
Source§

impl From<Error> for WebSocketError

Source§

fn from(source: Error) -> Self

Converts to this type from the input type.
Source§

impl From<ParseError> for WebSocketError

Source§

fn from(source: ParseError) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more