rustwave 0.1.0

A lightweight async event-driven WebSocket framework 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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143

use std::sync::Arc;

use crate::error::Result;
use serde::Serialize;
use uuid::Uuid;

use crate::server::server_handler::ServerStates;

/// A builder for sending an event to multiple clients, with optional
/// room targeting and sender exclusion.
///
/// # Example
///
/// ```no_run
/// use rustwave::{Server, Result};
///
/// #[tokio::main]
/// async fn main() -> Result<()> {
///     let server = Server::bind("127.0.0.1:8080");
///
///     server.on("message", |data, ctx| async move {
///         let _ = ctx.broadcast("message", data.raw())
///             .room("room-1")
///             .send()
///             .await;
///     });
///
///     server.run().await?;
///     Ok(())
/// }
/// ```
pub struct BroadcastBuilder<T: Serialize> {
    event: String,
    data: T,
    expect: Option<Uuid>,
    room: Option<String>,
    server: Arc<ServerStates>,
}

impl<T: Serialize> BroadcastBuilder<T> {
    pub(crate) fn new(event: String, data: T, server: Arc<ServerStates>) -> Self {
        Self {
            event,
            data,
            expect: None,
            room: None,
            server,
        }
    }

    /// Excludes the client matching `socket_id` from the broadcast.
    ///
    /// # Example
    ///
    /// ```no_run
    /// # use rustwave::{Server, Result};
    /// # #[tokio::main]
    /// # async fn main() -> Result<()> {
    /// # let server = Server::bind("127.0.0.1:8080");
    /// server.on("message", |data, ctx| async move {
    ///     let sender_id = ctx.get_socket_id();
    ///     let _ = ctx.broadcast("message", data.raw())
    ///         .expect(sender_id)
    ///         .send()
    ///         .await;
    /// });
    /// # Ok(())
    /// # }
    /// ```
    pub fn expect(mut self, socket_id: Uuid) -> Self {
        self.expect = Some(socket_id);
        self
    }

    /// Restricts the broadcast to clients that have joined `room`.
    ///
    /// If not called, the event is sent to every connected client instead.
    ///
    /// # Example
    ///
    /// ```no_run
    /// # use rustwave::{Server, Result};
    /// # #[tokio::main]
    /// # async fn main() -> Result<()> {
    /// # let server = Server::bind("127.0.0.1:8080");
    /// server.on("message", |data, ctx| async move {
    ///     let sender_id = ctx.get_socket_id();
    ///     let _ = ctx.broadcast("message", data.raw())
    ///         .room("room-1")
    ///         .send()
    ///         .await;
    /// });
    /// # Ok(())
    /// # }
    /// ```
    pub fn room(mut self, room: &str) -> Self {
        self.room = Some(room.to_string());
        self
    }

    /// Dispatches the broadcast, applying any `.room(...)` / `.expect(...)`
    /// configuration set beforehand.
    ///
    /// # Example
    ///
    /// ```no_run
    /// # use rustwave::{Server, Result};
    /// # #[tokio::main]
    /// # async fn main() -> Result<()> {
    /// # let server = Server::bind("127.0.0.1:8080");
    /// server.on("message", |data, ctx| async move {
    ///     let sender_id = ctx.get_socket_id();
    ///     let _ = ctx.broadcast("message", data.raw())
    ///         .room("room-1")
    ///         .expect(sender_id)
    ///         .send()
    ///         .await;
    /// });
    /// # Ok(())
    /// # }
    /// ```
    pub async fn send(&self) -> Result<()> {
        match &self.room {
            Some(v) => {
                if let Some(id) = self.expect {
                    self.server
                        .room_broadcast_except(v, &id, &self.event, &self.data)
                        .await?;
                    Ok(())
                } else {
                    self.server
                        .room_broadcast(v, &self.event, &self.data)
                        .await?;
                    Ok(())
                }
            }
            None => {
                self.server.broadcast(&self.event, &self.data).await?;
                Ok(())
            }
        }
    }
}