websockets 0.3.0

A WebSocket client implementation.
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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92

use native_tls::Error as NativeTlsError;
use std::io::Error as IoError;
use thiserror::Error;
use url::ParseError;

/// The possible error types from the WebSocket connection.
#[derive(Error, Debug)]
pub enum WebSocketError {
    // connection errors
    /// Error connecting using TCP
    #[error("could not connect using TCP")]
    TcpConnectionError(IoError),
    /// Error connecting using TLS
    #[error("could not connect using TLS")]
    TlsConnectionError(NativeTlsError),
    /// Error building WebSocket with given TLS configuration
    #[error("could not build WebSocket with given TLS configuration")]
    TlsBuilderError(NativeTlsError),
    /// Error creating a TLS configuration (such as in method calls on
    /// [`TlsCertificate`](crate::secure::TlsCertificate) or
    /// [`TlsIdentity`](crate::secure::TlsIdentity))
    #[error("error with TLS configuration")]
    TlsConfigurationError(NativeTlsError),
    /// Attempted to use the WebSocket when it is already closed
    #[error("websocket is already closed")]
    WebSocketClosedError,
    /// Error shutting down the internal stream
    #[error("error shutting down stream")]
    ShutdownError(IoError),

    // handshake errors
    /// Invalid handshake response from the server
    #[error("invalid handshake response")]
    InvalidHandshakeError,
    /// The server rejected the handshake request
    #[error("server rejected handshake")]
    HandshakeFailedError {
        /// Status code from the server's handshake response
        status_code: String,
        /// Headers from the server's handshake response
        headers: Vec<(String, String)>,
        /// Body of the server's handshake response, if any
        body: Option<String>,
    },

    // frame errors
    /// Attempted to use a control frame whose payload is more than 125 bytes
    #[error("control frame has payload larger than 125 bytes")]
    ControlFrameTooLargeError,
    /// Attempted to use a frame whose payload is too large
    #[error("payload is too large")]
    PayloadTooLargeError,
    /// Received an invalid frame
    #[error("received frame is invalid")]
    InvalidFrameError,
    /// Received a masked frame from the server
    #[error("received masked frame")]
    ReceivedMaskedFrameError,

    // url errors
    /// URL could not be parsed
    #[error("url could not be parsed")]
    ParseError(ParseError),
    /// URL has invalid WebSocket scheme (use "ws" or "wss")
    #[error(r#"invalid websocket scheme (use "ws" or "wss")"#)]
    SchemeError,
    /// URL host is invalid or missing
    #[error("invalid or missing host")]
    HostError,
    /// URL port is invalid
    #[error("invalid or unknown port")]
    PortError,
    /// Could not parse URL into SocketAddrs
    #[error("could not parse into SocketAddrs")]
    SocketAddrError(IoError),
    /// Could not resolve the URL's domain
    #[error("could not resolve domain")]
    ResolutionError,

    // reading and writing
    /// Error reading from WebSocket
    #[error("could not read from WebSocket")]
    ReadError(IoError),
    /// Error writing to WebSocket
    #[error("could not write to WebSocket")]
    WriteError(IoError),

    // splitting
    /// Issue with mpsc channel
    #[error("error using channel")]
    ChannelError,
}