openwire-core 0.1.1

Shared primitives, policies, bodies, and transport traits for OpenWire
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

use thiserror::Error;

use crate::WireError;

#[derive(Debug, Error)]
pub enum WebSocketError {
    #[error("handshake failed: {reason:?}")]
    Handshake {
        status: Option<http::StatusCode>,
        reason: HandshakeFailure,
    },

    #[error(transparent)]
    Engine(#[from] WebSocketEngineError),

    #[error("server closed the connection: {code} {reason}")]
    ClosedByPeer { code: u16, reason: String },

    #[error("websocket {0:?} timed out")]
    Timeout(TimeoutKind),

    #[error("transport io error: {0}")]
    Io(#[source] WireError),

    #[error("local cancellation")]
    LocalCancelled,
}

#[derive(Debug, Clone)]
pub enum HandshakeFailure {
    UnexpectedStatus,
    MissingUpgrade,
    MissingConnection,
    InvalidAccept,
    SubprotocolMismatch {
        offered: Vec<String>,
        returned: String,
    },
    UnsupportedExtension(String),
    Other(String),
}

#[derive(Debug, Clone, Copy)]
pub enum TimeoutKind {
    Handshake,
    Close,
    Ping,
}

#[derive(Debug, Error)]
pub enum WebSocketEngineError {
    #[error("invalid frame: {0}")]
    InvalidFrame(String),

    #[error("invalid utf-8 in text frame")]
    InvalidUtf8,

    #[error("invalid close code: {0}")]
    InvalidCloseCode(u16),

    #[error("payload too large: limit={limit} received={received}")]
    PayloadTooLarge { limit: usize, received: usize },

    #[error("unsupported extension: {0}")]
    UnsupportedExtension(String),

    #[error("io error: {0}")]
    Io(#[source] WireError),
}

impl WebSocketError {
    /// Convenience constructor for the bridge / transport branch.
    pub fn handshake(reason: HandshakeFailure, status: Option<http::StatusCode>) -> Self {
        Self::Handshake { status, reason }
    }
}