1
0
mirror of https://github.com/actix/actix-extras.git synced 2025-06-26 02:19:22 +02:00

re-arrange exports, some doc string updates

This commit is contained in:
Nikolay Kim
2018-03-29 10:44:26 -07:00
parent 32052c2750
commit ae6c9cb7fa
12 changed files with 74 additions and 16 deletions

View File

@ -268,6 +268,10 @@ struct Inner {
closed: bool,
}
/// Future that implementes client websocket handshake process.
///
/// It resolves to a pair of `ClientReadr` and `ClientWriter` that
/// can be used for reading and writing websocket frames.
pub struct ClientHandshake {
request: Option<SendRequest>,
tx: Option<UnboundedSender<Bytes>>,

View File

@ -82,7 +82,7 @@ pub type WsError = ProtocolError;
#[deprecated(since="0.4.2", note="please use `ws::HandshakeError` instead")]
pub type WsHandshakeError = HandshakeError;
/// Websocket errors
/// Websocket protocol errors
#[derive(Fail, Debug)]
pub enum ProtocolError {
/// Received an unmasked frame from client