Struct websocket_rs::Websocket

pub struct Websocket<S> { /* fields omitted */ }

Implementations

impl<S: 'static> Websocket<S> where
    S: AsyncRead + AsyncWrite + Unpin + Send, 

pub fn new(stream: S) -> Self

Create a new websocket instance, given any type that implements AsyncRead + AsyncWrite like tokio::net::TcpStream or tokio_native_tls::TlsStream

pub fn new_with_key(stream: S, key: String) -> Self

Same as Websocket::new except that it also accept a key that represent the value of Sec-Websocket-Key for client that requires a valid Sec-Websocket-Accept in response headers.

pub async fn next<'_>(&'_ mut self) -> Option<Message>

Wait for next frame to come. (support incoming fragmented frames)

pub async fn send_text<'_, T: AsRef<str>>(
    &'_ mut self,
    t: T
) -> WebsocketResult<()>

Send a text frame

Trait Implementations

impl<S: Debug> Debug for Websocket<S>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.