Struct yarws::Socket

pub struct Socket {
    pub no: usize,
    // some fields omitted
}

Represent a WebSocket connection. Used for sending and receiving messages.

Fields

no: usize

Methods

impl Socket

pub async fn recv<'_>(&'_ mut self) -> Option<Msg>

Receives Msg from the other side of the Socket connection. None is returned if the socket is closed.

Examples

Usually used in while loop:

    while let Some(msg) = socket.recv().await {
        // process msg
    }

pub async fn send<'_>(&'_ mut self, msg: Msg) -> Result<(), Error>

Sends Msg to the other side of the Socket connection. Errors if the socket is already closed.

Examples

Echo example. Receive Msgs and replay with the same Msg.

async fn echo(mut socket: Socket) -> Result<(), Error> {
    while let Some(msg) = socket.recv().await {
        socket.send(msg).await?;
    }
    Ok(())
}

pub async fn into_channel(self) -> (Sender<Msg>, Receiver<Msg>)

Transforms Socket into pair of mpsc channels for sending/receiving Msgs.

In some cases it is more convenient to have channels instead of calling methods. Ownership of each side of the channel can be moved to the different function.

pub fn into_text(self) -> TextSocket

Transforms Socket into TextSocket which is more convenient for handling text only messages.

Trait Implementations

impl Debug for Socket

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

Formats the value using the given formatter.