ferro-broadcast 0.2.12

WebSocket broadcasting and real-time channels for Ferro framework
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

//! Error types for the broadcast system.

use thiserror::Error;

/// Errors that can occur during broadcasting.
#[derive(Error, Debug)]
pub enum Error {
    /// WebSocket connection error.
    #[error("websocket error: {0}")]
    WebSocket(String),

    /// Channel not found.
    #[error("channel not found: {0}")]
    ChannelNotFound(String),

    /// Authorization failed.
    #[error("authorization failed: {0}")]
    AuthorizationFailed(String),

    /// Client not connected.
    #[error("client not connected: {0}")]
    ClientNotConnected(String),

    /// Serialization error.
    #[error("serialization error: {0}")]
    Serialization(#[from] serde_json::Error),

    /// Channel is full (too many subscribers).
    #[error("channel is full")]
    ChannelFull,

    /// Generic error.
    #[error("{0}")]
    Other(String),
}

impl Error {
    /// Create a WebSocket error.
    pub fn websocket(msg: impl Into<String>) -> Self {
        Self::WebSocket(msg.into())
    }

    /// Create an authorization failed error.
    pub fn unauthorized(msg: impl Into<String>) -> Self {
        Self::AuthorizationFailed(msg.into())
    }
}