Add 'WebSocket::accept_key()'.

This commit is contained in:
高奕GaoYi 2024-03-18 15:53:28 +08:00 committed by Sergio Benitez
parent 5398dfb34e
commit fd446a8ef4
1 changed files with 32 additions and 0 deletions

View File

@ -160,6 +160,38 @@ impl WebSocket {
{
MessageStream { ws: self, handler: Box::new(stream), }
}
/// Returns the server's fully computed and encoded WebSocket handshake
/// accept key.
///
/// > The server takes the value of the `Sec-WebSocket-Key` sent in the
/// > handshake request, appends `258EAFA5-E914-47DA-95CA-C5AB0DC85B11`,
/// > SHA-1 of the new value, and is then base64 encoded.
/// >
/// > -- [`Sec-WebSocket-Accept`]
///
/// This is the value returned via the [`Sec-WebSocket-Accept`] header
/// during the acceptance response.
///
/// [`Sec-WebSocket-Accept`]:
/// https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Sec-WebSocket-Accept
///
/// # Example
///
/// ```rust
/// # use rocket::get;
/// # use rocket_ws as ws;
/// #
/// #[get("/echo")]
/// fn echo_stream(ws: ws::WebSocket) -> ws::Stream!['static] {
/// let accept_key = ws.accept_key();
/// ws.stream(|io| io)
/// }
/// ```
pub fn accept_key(&self) -> &str {
&self.key
}
}
/// A streaming channel, returned by [`WebSocket::channel()`].