websock-proto 0.2.0

Protocol-level primitives shared across websock transports.
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

use thiserror::Error;

/// Result type for protocol and transport operations.
pub type Result<T> = std::result::Result<T, Error>;

/// Errors that can occur when sending or receiving WebSocket messages.
#[derive(Debug, Error)]
pub enum Error {
    /// The connection has been closed.
    #[error("connection closed")]
    Closed,

    /// The provided URL was not valid.
    #[error("invalid url: {0}")]
    InvalidUrl(String),

    /// A protocol violation or malformed message was encountered.
    #[error("protocol error: {0}")]
    Protocol(String),

    /// An IO failure occurred while reading or writing.
    #[error("io error: {0}")]
    Io(String),

    /// A TLS handshake or validation error occurred.
    #[error("tls error: {0}")]
    Tls(String),

    /// The operation is not supported on the current platform or configuration.
    #[error("unsupported: {0}")]
    Unsupported(String),

    #[error("frame decode error: {0}")]
    FrameDecode(String),

    #[error("stream id error: {0}")]
    StreamId(String),

    /// A catch-all error for unexpected failures.
    #[error("other error: {0}")]
    Other(String),
}

impl Error {
    /// Create an `Error::Other` from any displayable error value.
    pub fn other<E: std::fmt::Display>(e: E) -> Self {
        Self::Other(e.to_string())
    }
}