Struct WebSocketStream 

pub struct WebSocketStream { /* private fields */ }

Wrapper structure of a tcp stream with some websockets utilities

Implementations

impl WebSocketStream

pub fn from_tcp_stream_unchecked(stream: TcpStream) -> WebSocketStream

Wraps a tcp stream withot checking the handshake or anything

pub fn set_permit(&mut self, permit: OwnedSemaphorePermit)

Auxiliar function that cataclysm uses to keep track of connections

pub async fn send_message(&self, message: Message) -> Result<(), Error>

Sends a message through the websockets connection

pub async fn try_read_frame(&self) -> Result<Frame, Error>

Blocks until a message is received

pub fn split(self) -> (WebSocketWriter, WebSocketReader)

Splits the stream into the reading and writting part

Trait Implementations

impl AsMut<TcpStream> for WebSocketStream

fn as_mut(&mut self) -> &mut TcpStream

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<TcpStream> for WebSocketStream

fn as_ref(&self) -> &TcpStream

Converts this type into a shared reference of the (usually inferred) input type.

impl Into<TcpStream> for WebSocketStream

fn into(self) -> TcpStream

Converts this type into the (usually inferred) input type.