Enum tungstenite::error::Error
source · [−]pub enum Error {
ConnectionClosed,
AlreadyClosed,
Io(Error),
Tls(TlsError),
Capacity(CapacityError),
Protocol(ProtocolError),
SendQueueFull(Message),
Utf8,
Url(UrlError),
Http(Response<Option<String>>),
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.
SendQueueFull(Message)
Message send queue full.
Utf8
UTF coding error.
Url(UrlError)
Invalid URL.
Http(Response<Option<String>>)
HTTP error.
HttpFormat(Error)
HTTP format error.
Trait Implementations
sourceimpl Error for Error
impl Error for Error
sourcefn source(&self) -> Option<&(dyn Error + 'static)>
fn source(&self) -> Option<&(dyn Error + 'static)>
The lower-level source of this error, if any. Read more
sourcefn backtrace(&self) -> Option<&Backtrace>
fn backtrace(&self) -> Option<&Backtrace>
backtrace
)Returns a stack backtrace, if available, of where this error occurred. Read more
1.0.0 · sourcefn description(&self) -> &str
fn description(&self) -> &str
use the Display impl or to_string()
sourceimpl From<CapacityError> for Error
impl From<CapacityError> for Error
sourcefn from(source: CapacityError) -> Self
fn from(source: CapacityError) -> Self
Performs the conversion.
sourceimpl<Role: HandshakeRole> From<Error> for HandshakeError<Role>
impl<Role: HandshakeRole> From<Error> for HandshakeError<Role>
sourceimpl From<FromUtf8Error> for Error
impl From<FromUtf8Error> for Error
sourcefn from(_: FromUtf8Error) -> Self
fn from(_: FromUtf8Error) -> Self
Performs the conversion.
sourceimpl From<InvalidHeaderName> for Error
impl From<InvalidHeaderName> for Error
sourcefn from(err: InvalidHeaderName) -> Self
fn from(err: InvalidHeaderName) -> Self
Performs the conversion.
sourceimpl From<InvalidHeaderValue> for Error
impl From<InvalidHeaderValue> for Error
sourcefn from(err: InvalidHeaderValue) -> Self
fn from(err: InvalidHeaderValue) -> Self
Performs the conversion.
sourceimpl From<InvalidStatusCode> for Error
impl From<InvalidStatusCode> for Error
sourcefn from(err: InvalidStatusCode) -> Self
fn from(err: InvalidStatusCode) -> Self
Performs the conversion.
sourceimpl From<InvalidUri> for Error
impl From<InvalidUri> for Error
sourcefn from(err: InvalidUri) -> Self
fn from(err: InvalidUri) -> Self
Performs the conversion.
sourceimpl From<ProtocolError> for Error
impl From<ProtocolError> for Error
sourcefn from(source: ProtocolError) -> Self
fn from(source: ProtocolError) -> Self
Performs the conversion.
sourceimpl From<ToStrError> for Error
impl From<ToStrError> for Error
sourcefn from(_: ToStrError) -> Self
fn from(_: ToStrError) -> Self
Performs the conversion.
sourceimpl NonBlockingError for Error
impl NonBlockingError for Error
sourcefn into_non_blocking(self) -> Option<Self>
fn into_non_blocking(self) -> Option<Self>
Convert WouldBlock to None and don’t touch other errors.
Auto Trait Implementations
impl !RefUnwindSafe for Error
impl Send for Error
impl Sync for Error
impl Unpin for Error
impl !UnwindSafe for Error
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more