wynd 0.2.0

A simple websocket library for rust.
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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121

#![warn(missing_docs)]

use futures::stream::SplitSink;
use tokio::net::TcpStream;
use tokio_tungstenite::{WebSocketStream, tungstenite::Message};
use uuid::Uuid;

use crate::types::{BinaryMessageEvent, CloseEvent, ErrorEvent, TextMessageEvent};

/// Represents a single WebSocket connection and its callbacks.
pub struct Conn {
    /// Sender half of the WebSocket used to send frames to the client.
    pub(crate) sender: Option<SplitSink<WebSocketStream<TcpStream>, Message>>,
    /// Unique identifier for this connection instance.
    pub id: String,
    /// Async callback invoked when the connection is opened.
    pub(crate) on_open_cl: Box<
        dyn Fn() -> std::pin::Pin<Box<dyn std::future::Future<Output = ()> + Send>> + Send + Sync,
    >,
    /// Async callback invoked when a text message is received.
    pub(crate) on_text_message_cl: Box<
        dyn Fn(TextMessageEvent) -> std::pin::Pin<Box<dyn std::future::Future<Output = ()> + Send>>
            + Send
            + Sync,
    >,
    /// Async callback invoked when a binary message is received.
    pub(crate) on_binary_message_cl: Box<
        dyn Fn(
                BinaryMessageEvent,
            ) -> std::pin::Pin<Box<dyn std::future::Future<Output = ()> + Send>>
            + Send
            + Sync,
    >,
    /// Async callback invoked when the connection is closed.
    pub(crate) on_close_cl: Box<
        dyn Fn(CloseEvent) -> std::pin::Pin<Box<dyn std::future::Future<Output = ()> + Send>>
            + Send
            + Sync,
    >,
    /// Async callback invoked when an error occurs while handling the connection.
    pub(crate) on_error_cl: Box<
        dyn Fn(ErrorEvent) -> std::pin::Pin<Box<dyn std::future::Future<Output = ()> + Send>>
            + Send
            + Sync,
    >,
}

impl Conn {
    /// Creates a new `Conn` with default no-op callbacks and a new ID.
    pub fn new() -> Self {
        Self {
            on_open_cl: Box::new(|| {
                Box::pin(async {})
                    as std::pin::Pin<Box<dyn std::future::Future<Output = ()> + Send>>
            }),
            on_text_message_cl: Box::new(|_| {
                Box::pin(async {})
                    as std::pin::Pin<Box<dyn std::future::Future<Output = ()> + Send>>
            }),
            on_binary_message_cl: Box::new(|_| {
                Box::pin(async {})
                    as std::pin::Pin<Box<dyn std::future::Future<Output = ()> + Send>>
            }),
            on_close_cl: Box::new(|_| {
                Box::pin(async {})
                    as std::pin::Pin<Box<dyn std::future::Future<Output = ()> + Send>>
            }),
            on_error_cl: Box::new(|_| {
                Box::pin(async {})
                    as std::pin::Pin<Box<dyn std::future::Future<Output = ()> + Send>>
            }),
            id: Uuid::new_v4().to_string(),
            sender: None,
        }
    }

    /// Register an async callback invoked when the connection opens.
    pub fn on_open<F, Fut>(&mut self, open_cl: F)
    where
        F: Fn() -> Fut + Send + Sync + 'static,
        Fut: std::future::Future<Output = ()> + Send + 'static,
    {
        self.on_open_cl = Box::new(move || Box::pin(open_cl()));
    }

    /// Register an async callback invoked for each received text message.
    pub fn on_text<F, Fut>(&mut self, text_cl: F)
    where
        F: Fn(TextMessageEvent) -> Fut + Send + Sync + 'static,
        Fut: std::future::Future<Output = ()> + Send + 'static,
    {
        self.on_text_message_cl = Box::new(move |event| Box::pin(text_cl(event)));
    }

    /// Register an async callback invoked for each received binary message.
    pub fn on_binary<F, Fut>(&mut self, binary_cl: F)
    where
        F: Fn(BinaryMessageEvent) -> Fut + Send + Sync + 'static,
        Fut: std::future::Future<Output = ()> + Send + 'static,
    {
        self.on_binary_message_cl = Box::new(move |event| Box::pin(binary_cl(event)));
    }

    /// Register an async callback invoked when the connection closes.
    pub fn on_close<F, Fut>(&mut self, close_cl: F)
    where
        F: Fn(CloseEvent) -> Fut + Send + Sync + 'static,
        Fut: std::future::Future<Output = ()> + Send + 'static,
    {
        self.on_close_cl = Box::new(move |event| Box::pin(close_cl(event)));
    }

    /// Register an async callback invoked when an error occurs.
    pub fn on_error<F, Fut>(&mut self, error_cl: F)
    where
        F: Fn(ErrorEvent) -> Fut + Send + Sync + 'static,
        Fut: std::future::Future<Output = ()> + Send + 'static,
    {
        self.on_error_cl = Box::new(move |event| Box::pin(error_cl(event)));
    }
}