blitz-ws 0.1.0

Minimal stream-based WebSocket library
Documentation 
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

//! Convenience wrapper for streams to switch between plain TCP and TLS at runtime.
//!
//!  There is no dependency on actual TLS implementations. Everything like
//! `native_tls` or `openssl` will work as long as there is a TLS stream supporting standard
//! `Read + Write` traits.

#[cfg(feature = "__rustls-tls")]
use std::ops::Deref;
use std::{
    fmt::Debug,
    io::{Read, Result as IoResult, Write},
    net::TcpStream,
};

#[cfg(feature = "native-tls")]
use native_tls_crate::TlsStream;
#[cfg(feature = "__rustls-tls")]
use rustls::StreamOwned;

/// Stream mode, either plain TCP or TLS.
#[derive(Debug, Clone, Copy)]
pub enum Mode {
    /// Stream mode, either plain TCP or TLS.
    Plain,
    /// TLS mode (`wss://` URL).
    Tls,
}

/// Trait to switch TCP_NODELAY.
pub trait NoDelay {
    /// Set the TCP_NODELAY option to the given value.
    fn set_nodelay(&mut self, no_delay: bool) -> IoResult<()>;
}

impl NoDelay for TcpStream {
    fn set_nodelay(&mut self, no_delay: bool) -> IoResult<()> {
        TcpStream::set_nodelay(self, no_delay)
    }
}

#[cfg(feature = "native-tls")]
impl<S: Read + Write + NoDelay> NoDelay for TlsStream<S> {
    fn set_nodelay(&mut self, no_delay: bool) -> IoResult<()> {
        self.get_mut().set_nodelay(no_delay)
    }
}

#[cfg(feature = "__rustls-tls")]
impl<S, SD, T> NoDelay for StreamOwned<S, T>
where
    S: Deref<Target = rustls::ConnectionCommon<SD>>,
    SD: rustls::SideData,
    T: Read + Write + NoDelay,
{
    fn set_nodelay(&mut self, no_delay: bool) -> IoResult<()> {
        self.sock.set_nodelay(no_delay)
    }
}

/// A simplified stream abstraction that might be protected with TLS.
#[non_exhaustive]
#[allow(clippy::large_enum_variant)]
pub enum SimplifiedStream<S: Read + Write> {
    /// Unencrypted socket stream.
    Plain(S),

    /// Encrypted socket stream using `native-tls`.
    #[cfg(feature = "native-tls")]
    NativeTls(native_tls_crate::TlsStream<S>),

    /// Encrypted socket stream using `rustls`.
    #[cfg(feature = "__rustls-tls")]
    Rustls(rustls::StreamOwned<rustls::ClientConnection, S>),
}

impl<S: Read + Write + Debug> Debug for SimplifiedStream<S> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::Plain(s) => f.debug_tuple("SimplifiedStream::Plain").field(s).finish(),

            #[cfg(feature = "native-tls")]
            Self::NativeTls(s) => f.debug_tuple("SimplifiedStream::NativeTls").field(s).finish(),

            #[cfg(feature = "__rustls-tls")]
            Self::Rustls(s) => {
                struct RustlsStreamDebug<'a, S: Read + Write>(
                    &'a rustls::StreamOwned<rustls::ClientConnection, S>,
                );

                impl<S: Read + Write + Debug> Debug for RustlsStreamDebug<'_, S> {
                    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
                        f.debug_struct("StreamOwned")
                            .field("conn", &self.0.conn)
                            .field("sock", &self.0.sock)
                            .finish()
                    }
                }

                f.debug_tuple("SimplifiedStream::Rustls").field(&RustlsStreamDebug(s)).finish()
            }
        }
    }
}

impl<S: Read + Write> Read for SimplifiedStream<S> {
    fn read(&mut self, buf: &mut [u8]) -> IoResult<usize> {
        match self {
            Self::Plain(ref mut s) => s.read(buf),
            #[cfg(feature = "native-tls")]
            Self::NativeTls(ref mut s) => s.read(buf),
            #[cfg(feature = "__rustls-tls")]
            Self::Rustls(ref mut s) => s.read(buf),
        }
    }
}

impl<S: Read + Write> Write for SimplifiedStream<S> {
    fn write(&mut self, buf: &[u8]) -> IoResult<usize> {
        match self {
            Self::Plain(ref mut s) => s.write(buf),
            #[cfg(feature = "native-tls")]
            Self::NativeTls(ref mut s) => s.write(buf),
            #[cfg(feature = "__rustls-tls")]
            Self::Rustls(ref mut s) => s.write(buf),
        }
    }

    fn flush(&mut self) -> IoResult<()> {
        match self {
            Self::Plain(ref mut s) => s.flush(),
            #[cfg(feature = "native-tls")]
            Self::NativeTls(ref mut s) => s.flush(),
            #[cfg(feature = "__rustls-tls")]
            Self::Rustls(ref mut s) => s.flush(),
        }
    }
}

impl<S: Read + Write + NoDelay> NoDelay for SimplifiedStream<S> {
    fn set_nodelay(&mut self, no_delay: bool) -> IoResult<()> {
        match self {
            Self::Plain(ref mut s) => s.set_nodelay(no_delay),
            #[cfg(feature = "native-tls")]
            Self::NativeTls(ref mut s) => s.set_nodelay(no_delay),
            #[cfg(feature = "__rustls-tls")]
            Self::Rustls(ref mut s) => s.set_nodelay(no_delay),
        }
    }
}