socketeer 0.4.0

Simplified websocket client based on Tokio-Tungstenite
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

use thiserror::Error;
use tokio_tungstenite::tungstenite::Message;

/// Error type for the Socketeer library.
/// This type is used to represent all possible external errors that can occur when using the Socketeer library.
#[derive(Debug, Error)]
pub enum Error {
    /// Url Parse Error
    #[error("Failed to parse URL: {}", 0)]
    UrlParse {
        /// The URL that failed to parse
        url: String,
        /// The source of the error, from the [URL crate](https://docs.rs/url/2.2.2/url/enum.ParseError.html)
        #[source]
        source: url::ParseError,
    },
    /// Websocket Error
    /// Error thrown by the Tungstenite library when there is an issue with the websocket connection.
    #[error("Tungstenite error: {0}")]
    WebsocketError(#[from] tokio_tungstenite::tungstenite::Error),
    /// Socketeer error when the websocket connection is closed unexpectedly.
    #[error("Socket Closed")]
    WebsocketClosed,
    /// Error thrown if a message type not handled by `socketeer` is received.
    #[error("Unexpected Message type: {0}")]
    UnexpectedMessageType(Box<Message>),
    /// Error thrown if a [`crate::Codec`] fails to encode or decode a message.
    #[error("Codec error: {0}")]
    Codec(#[source] Box<dyn std::error::Error + Send + Sync>),
    /// Error thrown if socketeer is dropped without closing the connection.
    /// This error will be removed once async destructors are stabilized.
    /// See [issue](https://github.com/rust-lang/rust/issues/126482)
    #[error("Socketeer dropped without closing")]
    SocketeerDroppedWithoutClosing,
}