Struct WsByteStream

pub struct WsByteStream<S, Msg, E, H>
where
    S: Stream<Item = Result<Msg, E>> + Sink<Msg, Error = E> + Unpin,
    H: WsMessageHandle<Msg, E> + ?Sized,
{ /* private fields */ }

A wrapper implements AsyncRead, AsyncBufRead and AsyncWrite, around a established websocket connect which implemented Stream and Sink traits.

Bytes are transported on binary messages over WebSocket. Other messages except close messages will be ignored.

Assumption:

The underlying stream should automatically handle ping and pong messages.

Implementations

impl<S, Msg, E, H> WsByteStream<S, Msg, E, H>

where S: Stream<Item = Result<Msg, E>> + Sink<Msg, Error = E> + Unpin, H: WsMessageHandle<Msg, E> + ?Sized,

pub fn new(inner: S) -> Self

Trait Implementations

impl<S, Msg, E, H> AsyncBufRead for WsByteStream<S, Msg, E, H>

where S: Stream<Item = Result<Msg, E>> + Sink<Msg, Error = E> + Unpin, H: WsMessageHandle<Msg, E> + ?Sized,

fn poll_fill_buf( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<&[u8]>>

Attempt to return the contents of the internal buffer, filling it with more data from the inner reader if it is empty.

fn consume(self: Pin<&mut Self>, amt: usize)

Tells this buffer that amt bytes have been consumed from the buffer, so they should no longer be returned in calls to poll_read.

impl<S, Msg, E, H> AsyncBufRead for WsByteStream<S, Msg, E, H>

where S: Stream<Item = Result<Msg, E>> + Sink<Msg, Error = E> + Unpin, H: WsMessageHandle<Msg, E> + ?Sized,

Available on crate feature tokio only.

fn poll_fill_buf( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<&[u8]>>

Attempts to return the contents of the internal buffer, filling it with more data from the inner reader if it is empty.

fn consume(self: Pin<&mut Self>, amt: usize)

Tells this buffer that amt bytes have been consumed from the buffer, so they should no longer be returned in calls to poll_read.

impl<S, Msg, E, H> AsyncRead for WsByteStream<S, Msg, E, H>

where S: Stream<Item = Result<Msg, E>> + Sink<Msg, Error = E> + Unpin, H: WsMessageHandle<Msg, E> + ?Sized,

fn poll_read( self: Pin<&mut Self>, cx: &mut Context<'_>, dst: &mut [u8], ) -> Poll<Result<usize>>

Attempt to read from the AsyncRead into buf.

fn poll_read_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &mut [IoSliceMut<'_>], ) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into bufs using vectored IO operations.

impl<S, Msg, E, H> AsyncRead for WsByteStream<S, Msg, E, H>

where S: Stream<Item = Result<Msg, E>> + Sink<Msg, Error = E> + Unpin, H: WsMessageHandle<Msg, E> + ?Sized,

Available on crate feature tokio only.

fn poll_read( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &mut ReadBuf<'_>, ) -> Poll<Result<()>>

Attempts to read from the AsyncRead into buf.

impl<S, Msg, E, H> AsyncWrite for WsByteStream<S, Msg, E, H>

where S: Stream<Item = Result<Msg, E>> + Sink<Msg, Error = E> + Unpin, H: WsMessageHandle<Msg, E> + ?Sized,

fn poll_write( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &[u8], ) -> Poll<Result<usize>>

Attempt to write bytes from buf into the object.

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

Attempt to flush the object, ensuring that any buffered data reach their destination.

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

Attempt to close the object.

fn poll_write_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &[IoSlice<'_>], ) -> Poll<Result<usize, Error>>

Attempt to write bytes from bufs into the object using vectored IO operations.

impl<S, Msg, E, H> AsyncWrite for WsByteStream<S, Msg, E, H>

where S: Stream<Item = Result<Msg, E>> + Sink<Msg, Error = E> + Unpin, H: WsMessageHandle<Msg, E> + ?Sized,

Available on crate feature tokio only.

fn poll_write( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &[u8], ) -> Poll<Result<usize, Error>>

Attempt to write bytes from buf into the object.

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

Attempts to flush the object, ensuring that any buffered data reach their destination.

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

Initiates or attempts to shut down this writer, returning success when the I/O connection has completely shut down.

fn poll_write_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &[IoSlice<'_>], ) -> Poll<Result<usize, Error>>

Like poll_write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

Determines if this writer has an efficient poll_write_vectored implementation.

impl<'pin, S, Msg, E, H> Unpin for WsByteStream<S, Msg, E, H>

where S: Stream<Item = Result<Msg, E>> + Sink<Msg, Error = E> + Unpin, H: WsMessageHandle<Msg, E> + ?Sized, PinnedFieldsOf<__WsByteStream<'pin, S, Msg, E, H>>: Unpin,