Struct DuplexStream

pub struct DuplexStream(/* private fields */);

A readable and writeable WebSocket Message async stream.

This struct implements Stream and Sink, allowing for async reading and writing of Messages. The StreamExt and SinkExt traits can be imported to provide additional functionality for streams and sinks:

use rocket::futures::{SinkExt, StreamExt};

#[get("/echo/manual")]
fn echo_manual<'r>(ws: ws::WebSocket) -> ws::Channel<'r> {
    ws.channel(move |mut stream| Box::pin(async move {
        while let Some(message) = stream.next().await {
            let _ = stream.send(message?).await;
        }

        Ok(())
    }))
}

Implementations

impl DuplexStream

pub async fn close(&mut self, msg: Option<CloseFrame<'_>>) -> Result<()>

Close the stream now. This does not typically need to be called.

Trait Implementations

impl FusedStream for DuplexStream

fn is_terminated(&self) -> bool

Returns true if the stream should no longer be polled.

impl Sink<Message> for DuplexStream

type Error = Error

The type of value produced by the sink when an error occurs.

fn poll_ready( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Attempts to prepare the Sink to receive a value.

fn start_send(self: Pin<&mut Self>, item: Message) -> Result<(), Self::Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

fn poll_flush( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Flush any remaining output from this sink.

fn poll_close( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Flush any remaining output and close this sink, if necessary.

impl Stream for DuplexStream

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.