Struct WSConnection

pub struct WSConnection { /* private fields */ }

WSConnection represents the final connection of a client/server, after all the steps of establishing a connection have been properly met. This structure will be delivered to the end-user, which contains the reader, which would be used as a stream, for reading all the data that comes in this connection, and the writer, for writing data into the stream.

Implementations

impl WSConnection

pub fn new(writer: WSWriter, reader: WSReader) -> Self

pub fn split(self) -> (WSReader, WSWriter)

This function will split the connection into the WSReader, which is a stream of messages and WSWriter, for writing data into the socket. It’s a good option when you need to work with both in separate tasks or functions

pub async fn close_connection(&mut self) -> Result<(), Error>

This function will be used for closing the connection between two instances, mainly it will be used by a client, to request disconnection with a server.It first sends a close frame through the socket, and waits until it receives the confirmation in a channel executing it inside a timeout, to avoid a long waiting time

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

Send a general message, which is a good option for echoing messages

pub async fn send(&mut self, data: Vec<u8>) -> Result<(), Error>

Send generic data, by default it considers OpCode Text

pub async fn send_as_binary(&mut self, data: Vec<u8>) -> Result<(), Error>

Send a message as Binary Opcode

pub async fn send_as_text(&mut self, data: String) -> Result<(), Error>

Send a message as a String

pub async fn send_ping(&mut self) -> Result<(), Error>

Sends a Ping OpCode to client/server

pub async fn send_large_data_fragmented( &mut self, data: Vec<u8>, fragment_size: usize, ) -> Result<(), Error>

Send data fragmented, where fragment_size should be a value calculated in powers of 2 The payload would be divided into that size, still considering connection configurations like max_frame_size

Trait Implementations

impl Stream for WSConnection

type Item = Result<Message, Error>

Values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.