# proto.rs.html -- source
Source to the Rust file `src/ws/proto.rs`.
Keywords: rust, rustlang, rust-lang

      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
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    266
    267
    268
    269
    270
    271
    272
    273
    274
    275
    276
    277
    278
    279
    280
    281
    282
    283
    284
    285
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318

    use base64;
    use sha1;
    use std::convert::{From, Into};
    use std::fmt;

    use self::OpCode::*;
    /// Operation codes as part of rfc6455.
    #[derive(Debug, Eq, PartialEq, Clone, Copy)]
    pub enum OpCode {
        /// Indicates a continuation frame of a fragmented message.
        Continue,
        /// Indicates a text data frame.
        Text,
        /// Indicates a binary data frame.
        Binary,
        /// Indicates a close control frame.
        Close,
        /// Indicates a ping control frame.
        Ping,
        /// Indicates a pong control frame.
        Pong,
        /// Indicates an invalid opcode was received.
        Bad,
    }

    impl fmt::Display for OpCode {
        fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
            match *self {
                Continue => write!(f, "CONTINUE"),
                Text => write!(f, "TEXT"),
                Binary => write!(f, "BINARY"),
                Close => write!(f, "CLOSE"),
                Ping => write!(f, "PING"),
                Pong => write!(f, "PONG"),
                Bad => write!(f, "BAD"),
            }
        }
    }

    impl Into<u8> for OpCode {
        fn into(self) -> u8 {
            match self {
                Continue => 0,
                Text => 1,
                Binary => 2,
                Close => 8,
                Ping => 9,
                Pong => 10,
                Bad => {
                    debug_assert!(
                        false,
                        "Attempted to convert invalid opcode to u8. This is a bug."
                    );
                    8 // if this somehow happens, a close frame will help us tear down quickly
                }
            }
        }
    }

    impl From<u8> for OpCode {
        fn from(byte: u8) -> OpCode {
            match byte {
                0 => Continue,
                1 => Text,
                2 => Binary,
                8 => Close,
                9 => Ping,
                10 => Pong,
                _ => Bad,
            }
        }
    }

    use self::CloseCode::*;
    /// Status code used to indicate why an endpoint is closing the `WebSocket`
    /// connection.
    #[derive(Debug, Eq, PartialEq, Clone, Copy)]
    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 an abnormal closure. If the abnormal closure was due to an
        /// error, this close code will not be used. Instead, the `on_error` method
        /// of the handler will be called with the error. However, if the connection
        /// is simply dropped, without an error, this close code will be sent to the
        /// handler.
        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,
        #[doc(hidden)]
        Tls,
        #[doc(hidden)]
        Other(u16),
    }

    impl Into<u16> for CloseCode {
        fn into(self) -> u16 {
            match self {
                Normal => 1000,
                Away => 1001,
                Protocol => 1002,
                Unsupported => 1003,
                Abnormal => 1006,
                Invalid => 1007,
                Policy => 1008,
                Size => 1009,
                Extension => 1010,
                Error => 1011,
                Restart => 1012,
                Again => 1013,
                Tls => 1015,
                Other(code) => code,
            }
        }
    }

    impl From<u16> for CloseCode {
        fn from(code: u16) -> CloseCode {
            match code {
                1000 => Normal,
                1001 => Away,
                1002 => Protocol,
                1003 => Unsupported,
                1006 => Abnormal,
                1007 => Invalid,
                1008 => Policy,
                1009 => Size,
                1010 => Extension,
                1011 => Error,
                1012 => Restart,
                1013 => Again,
                1015 => Tls,
                _ => Other(code),
            }
        }
    }

    #[derive(Debug, Eq, PartialEq, Clone)]
    /// Reason for closing the connection
    pub struct CloseReason {
        /// Exit code
        pub code: CloseCode,
        /// Optional description of the exit code
        pub description: Option<String>,
    }

    impl From<CloseCode> for CloseReason {
        fn from(code: CloseCode) -> Self {
            CloseReason {
                code,
                description: None,
            }
        }
    }

    impl<T: Into<String>> From<(CloseCode, T)> for CloseReason {
        fn from(info: (CloseCode, T)) -> Self {
            CloseReason {
                code: info.0,
                description: Some(info.1.into()),
            }
        }
    }

    static WS_GUID: &'static str = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";

    // TODO: hash is always same size, we dont need String
    pub(crate) fn hash_key(key: &[u8]) -> String {
        let mut hasher = sha1::Sha1::new();

        hasher.update(key);
        hasher.update(WS_GUID.as_bytes());

        base64::encode(&hasher.digest().bytes())
    }

    #[cfg(test)]
    mod test {
        #![allow(unused_imports, unused_variables, dead_code)]
        use super::*;

        macro_rules! opcode_into {
            ($from:expr => $opcode:pat) => {
                match OpCode::from($from) {
                    e @ $opcode => (),
                    e => unreachable!("{:?}", e),
                }
            };
        }

        macro_rules! opcode_from {
            ($from:expr => $opcode:pat) => {
                let res: u8 = $from.into();
                match res {
                    e @ $opcode => (),
                    e => unreachable!("{:?}", e),
                }
            };
        }

        #[test]
        fn test_to_opcode() {
            opcode_into!(0 => OpCode::Continue);
            opcode_into!(1 => OpCode::Text);
            opcode_into!(2 => OpCode::Binary);
            opcode_into!(8 => OpCode::Close);
            opcode_into!(9 => OpCode::Ping);
            opcode_into!(10 => OpCode::Pong);
            opcode_into!(99 => OpCode::Bad);
        }

        #[test]
        fn test_from_opcode() {
            opcode_from!(OpCode::Continue => 0);
            opcode_from!(OpCode::Text => 1);
            opcode_from!(OpCode::Binary => 2);
            opcode_from!(OpCode::Close => 8);
            opcode_from!(OpCode::Ping => 9);
            opcode_from!(OpCode::Pong => 10);
        }

        #[test]
        #[should_panic]
        fn test_from_opcode_debug() {
            opcode_from!(OpCode::Bad => 99);
        }

        #[test]
        fn test_from_opcode_display() {
            assert_eq!(format!("{}", OpCode::Continue), "CONTINUE");
            assert_eq!(format!("{}", OpCode::Text), "TEXT");
            assert_eq!(format!("{}", OpCode::Binary), "BINARY");
            assert_eq!(format!("{}", OpCode::Close), "CLOSE");
            assert_eq!(format!("{}", OpCode::Ping), "PING");
            assert_eq!(format!("{}", OpCode::Pong), "PONG");
            assert_eq!(format!("{}", OpCode::Bad), "BAD");
        }

        #[test]
        fn closecode_from_u16() {
            assert_eq!(CloseCode::from(1000u16), CloseCode::Normal);
            assert_eq!(CloseCode::from(1001u16), CloseCode::Away);
            assert_eq!(CloseCode::from(1002u16), CloseCode::Protocol);
            assert_eq!(CloseCode::from(1003u16), CloseCode::Unsupported);
            assert_eq!(CloseCode::from(1006u16), CloseCode::Abnormal);
            assert_eq!(CloseCode::from(1007u16), CloseCode::Invalid);
            assert_eq!(CloseCode::from(1008u16), CloseCode::Policy);
            assert_eq!(CloseCode::from(1009u16), CloseCode::Size);
            assert_eq!(CloseCode::from(1010u16), CloseCode::Extension);
            assert_eq!(CloseCode::from(1011u16), CloseCode::Error);
            assert_eq!(CloseCode::from(1012u16), CloseCode::Restart);
            assert_eq!(CloseCode::from(1013u16), CloseCode::Again);
            assert_eq!(CloseCode::from(1015u16), CloseCode::Tls);
            assert_eq!(CloseCode::from(2000u16), CloseCode::Other(2000));
        }

        #[test]
        fn closecode_into_u16() {
            assert_eq!(1000u16, Into::<u16>::into(CloseCode::Normal));
            assert_eq!(1001u16, Into::<u16>::into(CloseCode::Away));
            assert_eq!(1002u16, Into::<u16>::into(CloseCode::Protocol));
            assert_eq!(1003u16, Into::<u16>::into(CloseCode::Unsupported));
            assert_eq!(1006u16, Into::<u16>::into(CloseCode::Abnormal));
            assert_eq!(1007u16, Into::<u16>::into(CloseCode::Invalid));
            assert_eq!(1008u16, Into::<u16>::into(CloseCode::Policy));
            assert_eq!(1009u16, Into::<u16>::into(CloseCode::Size));
            assert_eq!(1010u16, Into::<u16>::into(CloseCode::Extension));
            assert_eq!(1011u16, Into::<u16>::into(CloseCode::Error));
            assert_eq!(1012u16, Into::<u16>::into(CloseCode::Restart));
            assert_eq!(1013u16, Into::<u16>::into(CloseCode::Again));
            assert_eq!(1015u16, Into::<u16>::into(CloseCode::Tls));
            assert_eq!(2000u16, Into::<u16>::into(CloseCode::Other(2000)));
        }
    }

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)