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 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252
/// Status code used to indicate why an endpoint is closing the WebSocket
/// connection.
#[derive(Debug, Copy, Clone, Eq, PartialEq)]
pub enum CloseCode {
/// Indicates a normal closure, meaning that the purpose for
/// which the connection was established has been fulfilled.
Normal,
/// Indicates that an endpoint is "going away", such as a server
/// going down or a browser having navigated away from a page.
Away,
/// Indicates that an endpoint is terminating the connection due
/// to a protocol error.
Protocol,
/// Indicates that an endpoint is terminating the connection
/// because it has received a type of data it cannot accept (e.g., an
/// endpoint that understands only text data MAY send this if it
/// receives a binary message).
Unsupported,
/// Indicates that no status code was included in a closing frame.
Status,
/// Indicates an abnormal closure.
Abnormal,
/// Indicates that an endpoint is terminating the connection
/// because it has received data within a message that was not
/// consistent with the type of the message (e.g., non-UTF-8 \[RFC3629\]
/// data within a text message).
Invalid,
/// Indicates that an endpoint is terminating the connection
/// because it has received a message that violates its policy. This
/// is a generic status code that can be returned when there is no
/// other more suitable status code (e.g., Unsupported or Size) or if there
/// is a need to hide specific details about the policy.
Policy,
/// Indicates that an endpoint is terminating the connection
/// because it has received a message that is too big for it to
/// process.
Size,
/// Indicates that an endpoint (client) is terminating the
/// connection because it has expected the server to negotiate one or
/// more extension, but the server didn't return them in the response
/// message of the WebSocket handshake. The list of extensions that
/// are needed should be given as the reason for closing.
/// Note that this status code is not used by the server, because it
/// can fail the WebSocket handshake instead.
Extension,
/// Indicates that a server is terminating the connection because
/// it encountered an unexpected condition that prevented it from
/// fulfilling the request.
Error,
/// Indicates that the server is restarting. A client may choose to
/// reconnect, and if it does, it should use a randomized delay of 5-30
/// seconds between attempts.
Restart,
/// Indicates that the server is overloaded and the client should either
/// connect to a different IP (when multiple targets exist), or
/// reconnect to the same IP when a user has performed an action.
Again,
/// Code reserved for the future.
Reserved(u16),
}
impl From<u16> for CloseCode {
fn from(code: u16) -> Self {
use CloseCode::*;
match code {
1000 => Normal,
1001 => Away,
1002 => Protocol,
1003 => Unsupported,
1005 => Status,
1006 => Abnormal,
1007 => Invalid,
1008 => Policy,
1009 => Size,
1010 => Extension,
1011 => Error,
1012 => Restart,
1013 => Again,
_ => Reserved(code),
}
}
}
impl From<CloseCode> for u16 {
fn from(code: CloseCode) -> Self {
use CloseCode::*;
match code {
Normal => 1000,
Away => 1001,
Protocol => 1002,
Unsupported => 1003,
Status => 1005,
Abnormal => 1006,
Invalid => 1007,
Policy => 1008,
Size => 1009,
Extension => 1010,
Error => 1011,
Restart => 1012,
Again => 1013,
Reserved(code) => code,
}
}
}
/// An enum representing the various forms of a WebSocket message.
#[derive(Debug, Clone, Eq, PartialEq)]
pub enum Message {
/// A text WebSocket message
Text(String),
/// A binary WebSocket message
Binary(Vec<u8>),
/// A ping message with the specified payload
///
/// The payload here must have a length less than 125 bytes
Ping(Vec<u8>),
/// A pong message with the specified payload
///
/// The payload here must have a length less than 125 bytes
Pong(Vec<u8>),
/// A close message with the optional close frame.
Close(Option<(CloseCode, String)>),
}
impl Message {
/// Construct a new text message.
pub fn text(text: impl Into<String>) -> Self {
Self::Text(text.into())
}
/// Construct a new binary message.
pub fn binary(data: impl Into<Vec<u8>>) -> Self {
Self::Binary(data.into())
}
/// Construct a new ping message.
pub fn ping(data: impl Into<Vec<u8>>) -> Self {
Self::Ping(data.into())
}
/// Construct a new pong message.
pub fn pong(data: impl Into<Vec<u8>>) -> Self {
Self::Pong(data.into())
}
/// Construct the default close message.
pub fn close() -> Self {
Self::Close(None)
}
/// Construct a close message with a code and reason.
pub fn close_with(code: impl Into<CloseCode>, reason: impl Into<String>) -> Self {
Self::Close(Some((code.into(), reason.into())))
}
/// Returns true if this message is a Text message.
#[inline]
pub fn is_text(&self) -> bool {
matches!(self, Message::Text(_))
}
/// Returns true if this message is a Binary message.
#[inline]
pub fn is_binary(&self) -> bool {
matches!(self, Message::Binary(_))
}
/// Returns true if this message is a Ping message.
pub fn is_ping(&self) -> bool {
matches!(self, Message::Ping(_))
}
/// Returns true if this message is a Pong message.
pub fn is_pong(&self) -> bool {
matches!(self, Message::Pong(_))
}
/// Returns true if this message a is a Close message.
pub fn is_close(&self) -> bool {
matches!(self, Message::Close(_))
}
/// Destructure this message into binary data.
pub fn into_bytes(self) -> Vec<u8> {
match self {
Message::Text(data) => data.into_bytes(),
Message::Binary(data) => data,
Message::Ping(data) => data,
Message::Pong(data) => data,
Message::Close(_) => Default::default(),
}
}
/// Return the bytes of this message, if the message can contain data.
pub fn as_bytes(&self) -> &[u8] {
match self {
Message::Text(data) => data.as_bytes(),
Message::Binary(data) => data,
Message::Ping(data) => data,
Message::Pong(data) => data,
Message::Close(_) => &[],
}
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_message() {
assert_eq!(Message::text("abc"), Message::Text("abc".to_string()));
assert_eq!(
Message::binary(vec![1, 2, 3]),
Message::Binary(vec![1, 2, 3])
);
assert_eq!(Message::ping(vec![1, 2, 3]), Message::Ping(vec![1, 2, 3]));
assert_eq!(Message::pong(vec![1, 2, 3]), Message::Pong(vec![1, 2, 3]));
assert_eq!(Message::close(), Message::Close(None));
assert_eq!(
Message::close_with(CloseCode::Again, "again"),
Message::Close(Some((CloseCode::Again, "again".to_string())))
);
assert!(Message::text("abc").is_text());
assert!(Message::binary("abc").is_binary());
assert!(Message::ping(vec![1, 2, 3]).is_ping());
assert!(Message::pong(vec![1, 2, 3]).is_pong());
assert!(Message::close().is_close());
assert_eq!(
Message::text("abc").into_bytes(),
"abc".to_string().into_bytes()
);
assert_eq!(Message::binary(vec![1, 2, 3]).into_bytes(), vec![1, 2, 3]);
assert_eq!(Message::ping(vec![1, 2, 3]).into_bytes(), vec![1, 2, 3]);
assert_eq!(Message::pong(vec![1, 2, 3]).into_bytes(), vec![1, 2, 3]);
assert_eq!(Message::close().into_bytes(), Vec::<u8>::new());
assert_eq!(Message::text("abc").as_bytes(), "abc".as_bytes());
assert_eq!(Message::binary(vec![1, 2, 3]).as_bytes(), &[1, 2, 3]);
assert_eq!(Message::ping(vec![1, 2, 3]).as_bytes(), &[1, 2, 3]);
assert_eq!(Message::pong(vec![1, 2, 3]).as_bytes(), &[1, 2, 3]);
assert_eq!(Message::close().as_bytes(), &[] as &[u8]);
}
}