Struct wisp_mux::MuxStream

pub struct MuxStream<W>
where
    W: WebSocketWrite,
{
    pub stream_id: u32,
    /* private fields */
}

Multiplexor stream.

Fields

stream_id: u32

ID of the stream.

Implementations

impl<W: WebSocketWrite + Send + 'static> MuxStream<W>

pub async fn read(&mut self) -> Option<MuxEvent>

Read an event from the stream.

pub async fn write(&self, data: Bytes) -> Result<(), WispError>

Write data to the stream.

pub fn get_close_handle(&self) -> MuxStreamCloser

Get a handle to close the connection.

Useful to close the connection without having access to the stream.

Example

let handle = stream.get_close_handle();
if let Err(error) = handle_stream(stream) {
    handle.close(0x01);
}

pub async fn close(&self, reason: CloseReason) -> Result<(), WispError>

Close the stream. You will no longer be able to write or read after this has been called.

pub fn into_split(self) -> (MuxStreamRead<W>, MuxStreamWrite<W>)

Split the stream into read and write parts, consuming it.

pub fn into_io(self) -> MuxStreamIo

Turn the stream into one that implements futures Stream + Sink, consuming it.