Struct WebSocketStream

pub struct WebSocketStream<T> { /* private fields */ }

A WebSocket stream that full messages can be read from and written to.

The stream implements futures_sink::Sink and futures_core::Stream.

You must use a ClientBuilder or ServerBuilder to obtain a WebSocket stream.

For usage examples, see the top level crate documentation, which showcases a simple echo server and client.

Implementations

impl<T> WebSocketStream<T>

where T: AsyncRead + AsyncWrite + Unpin,

pub fn get_ref(&self) -> &T

Returns a reference to the underlying I/O stream wrapped by this stream.

Care should be taken not to tamper with the stream of data to avoid corrupting the stream of frames.

pub fn get_mut(&mut self) -> &mut T

Returns a mutable reference to the underlying I/O stream wrapped by this stream.

Care should be taken not to tamper with the stream of data to avoid corrupting the stream of frames.

pub fn limits(&self) -> &Limits

Returns a reference to the inner websocket limits.

pub fn limits_mut(&mut self) -> &mut Limits

Returns a mutable reference to the inner websocket limits.

Trait Implementations

impl<T: Debug> Debug for WebSocketStream<T>

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

Formats the value using the given formatter.

impl<T> Sink<Message> for WebSocketStream<T>

where T: AsyncRead + AsyncWrite + Unpin,

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<T> Stream for WebSocketStream<T>

where T: AsyncRead + AsyncWrite + Unpin,

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.