twilight_gateway/
message.rs

1//! Raw websocket message.
2//!
3//! This is mostly equivalent to the underlying websocket library's message, but
4//! this intermediary exists to prevent exposing it in the public API. Messages
5//! constructed are equivalent to what the underlying library will receive. The
6//! input will not be checked and will be passed directly to the underlying
7//! websocket library.
8
9use std::borrow::Cow;
10
11use tokio_websockets::{CloseCode, Message as WebsocketMessage};
12use twilight_model::gateway::CloseFrame;
13
14/// Message to send over the connection to the remote.
15#[derive(Clone, Debug, Eq, PartialEq)]
16pub enum Message {
17    /// Close message with an optional frame including information about the
18    /// reason for the close.
19    Close(Option<CloseFrame<'static>>),
20    /// Text websocket message.
21    ///
22    /// Should always be a JSON payload.
23    Text(String),
24}
25
26impl Message {
27    /// Close message indicating the connection was closed abnormally.
28    pub(crate) const ABNORMAL_CLOSE: Self = Self::Close(Some(CloseFrame::new(1006, "")));
29
30    /// Whether the message is a close message.
31    pub const fn is_close(&self) -> bool {
32        matches!(self, Self::Close(_))
33    }
34
35    /// Whether the message is a text message.
36    pub const fn is_text(&self) -> bool {
37        matches!(self, Self::Text(_))
38    }
39
40    /// Convert a `tokio-websockets` websocket message into a `twilight` websocket
41    /// message.
42    pub(crate) fn from_websocket_msg(msg: &WebsocketMessage) -> Option<Self> {
43        if msg.is_close() {
44            let (code, reason) = msg.as_close().unwrap();
45
46            let frame = (code != CloseCode::NO_STATUS_RECEIVED).then(|| CloseFrame {
47                code: code.into(),
48                reason: Cow::Owned(reason.to_string()),
49            });
50
51            Some(Self::Close(frame))
52        } else if msg.is_text() {
53            Some(Self::Text(msg.as_text().unwrap().to_owned()))
54        } else {
55            None
56        }
57    }
58
59    /// Convert a `twilight` websocket message into a `tokio-websockets` websocket
60    /// message.
61    pub(crate) fn into_websocket_msg(self) -> WebsocketMessage {
62        match self {
63            Self::Close(frame) => WebsocketMessage::close(
64                frame
65                    .as_ref()
66                    .and_then(|f| CloseCode::try_from(f.code).ok()),
67                frame.map(|f| f.reason).as_deref().unwrap_or_default(),
68            ),
69            Self::Text(string) => WebsocketMessage::text(string),
70        }
71    }
72}
73
74#[cfg(test)]
75mod tests {
76    use super::Message;
77    use static_assertions::assert_impl_all;
78    use std::fmt::Debug;
79
80    assert_impl_all!(Message: Clone, Debug, Eq, PartialEq);
81}
twilight_gateway/message.rs

twilight_gateway/
message.rs
