ws-kit 0.1.0

Generic authenticated typed WebSocket — BroadcastHub, RoomManager, heartbeat, and token extraction for Axum
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

//! Error types for `ws-kit`.
//!
//! All WebSocket failures are represented by [`WsError`]. For token-extraction
//! specific errors see [`crate::extractor::WsAuthError`].

use thiserror::Error;

/// WebSocket error variants.
///
/// Each variant maps to a failure mode encountered during authentication,
/// connection management, or message handling.
#[derive(Debug, Error, Clone, PartialEq, Eq)]
pub enum WsError {
    /// No authentication token was provided.
    #[error("authentication token missing")]
    AuthMissing,

    /// Provided authentication token is invalid or expired.
    #[error("authentication token invalid")]
    AuthInvalid,

    /// Connection limit reached.
    #[error("too many connections")]
    TooManyConnections,

    /// Broadcast channel is full or lagged.
    #[error("broadcast channel full")]
    BroadcastFull,

    /// Incoming message could not be parsed or is semantically invalid.
    #[error("invalid message")]
    InvalidMessage,

    /// Connection has been closed.
    #[error("connection closed")]
    Closed,
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn display_messages() {
        assert_eq!(WsError::AuthMissing.to_string(), "authentication token missing");
        assert_eq!(WsError::AuthInvalid.to_string(), "authentication token invalid");
        assert_eq!(WsError::TooManyConnections.to_string(), "too many connections");
        assert_eq!(WsError::BroadcastFull.to_string(), "broadcast channel full");
        assert_eq!(WsError::InvalidMessage.to_string(), "invalid message");
        assert_eq!(WsError::Closed.to_string(), "connection closed");
    }

    #[test]
    fn clone_eq() {
        let e = WsError::AuthMissing;
        assert_eq!(e.clone(), WsError::AuthMissing);
        assert_ne!(WsError::AuthMissing, WsError::Closed);
    }
}