pub enum TungsteniteError {
ConnectionClosed,
AlreadyClosed,
Io(Error),
Tls(TlsError),
Capacity(CapacityError),
Protocol(ProtocolError),
WriteBufferFull(Message),
Utf8,
AttackAttempt,
Url(UrlError),
Http(Response<Option<Vec<u8>>>),
HttpFormat(Error),
}Expand description
Possible WebSocket errors.
Variants§
ConnectionClosed
WebSocket connection closed normally. This informs you of the close. It’s not an error as such and nothing wrong happened.
This is returned as soon as the close handshake is finished (we have both sent and received a close frame) on the server end and as soon as the server has closed the underlying connection if this endpoint is a client.
Thus when you receive this, it is safe to drop the underlying connection.
Receiving this error means that the WebSocket object is not usable anymore and the only meaningful action with it is dropping it.
AlreadyClosed
Trying to work with already closed connection.
Trying to read or write after receiving ConnectionClosed causes this.
As opposed to ConnectionClosed, this indicates your code tries to operate on the
connection when it really shouldn’t anymore, so this really indicates a programmer
error on your part.
Io(Error)
Input-output error. Apart from WouldBlock, these are generally errors with the underlying connection and you should probably consider them fatal.
Tls(TlsError)
TLS error.
Note that this error variant is enabled unconditionally even if no TLS feature is enabled, to provide a feature-agnostic API surface.
Capacity(CapacityError)
- When reading: buffer capacity exhausted.
- When writing: your message is bigger than the configured max message size (64MB by default).
Protocol(ProtocolError)
Protocol violation.
WriteBufferFull(Message)
Message write buffer is full.
Utf8
UTF coding error.
AttackAttempt
Attack attempt detected.
Url(UrlError)
Invalid URL.
Http(Response<Option<Vec<u8>>>)
HTTP error.
HttpFormat(Error)
HTTP format error.