Struct stream_ws::WsByteStream
source · 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 */ }
Expand description
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§
source§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,
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,
Trait Implementations§
source§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.
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.source§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,
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,
source§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.
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.source§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,
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,
source§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,
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,
source§fn poll_write(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
buf: &[u8]
) -> Poll<Result<usize>>
fn poll_write( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &[u8] ) -> Poll<Result<usize>>
Attempt to write bytes from
buf
into the object. Read moresource§fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>
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. Read more
source§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.
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.source§fn poll_write(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
buf: &[u8]
) -> Poll<Result<usize, Error>>
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. Read moresource§fn poll_flush(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<(), Error>>
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. Read more
source§fn poll_shutdown(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<(), Error>>
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. Read more
source§fn poll_write_vectored(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
bufs: &[IoSlice<'_>]
) -> Poll<Result<usize, Error>>
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. Read moresource§fn is_write_vectored(&self) -> bool
fn is_write_vectored(&self) -> bool
Determines if this writer has an efficient
poll_write_vectored
implementation. Read moreimpl<'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, __WsByteStream<'pin, S, Msg, E, H>: Unpin,
Auto Trait Implementations§
impl<S, Msg, E, H: ?Sized> RefUnwindSafe for WsByteStream<S, Msg, E, H>where H: RefUnwindSafe, S: RefUnwindSafe,
impl<S, Msg, E, H: ?Sized> Send for WsByteStream<S, Msg, E, H>where H: Send, S: Send,
impl<S, Msg, E, H: ?Sized> Sync for WsByteStream<S, Msg, E, H>where H: Sync, S: Sync,
impl<S, Msg, E, H: ?Sized> UnwindSafe for WsByteStream<S, Msg, E, H>where H: UnwindSafe, S: UnwindSafe,
Blanket Implementations§
§impl<R> AsyncBufReadExt for Rwhere
R: AsyncBufRead + ?Sized,
impl<R> AsyncBufReadExt for Rwhere R: AsyncBufRead + ?Sized,
§fn fill_buf(&mut self) -> FillBuf<'_, Self>where
Self: Unpin,
fn fill_buf(&mut self) -> FillBuf<'_, Self>where Self: Unpin,
Creates a future which will wait for a non-empty buffer to be available from this I/O
object or EOF to be reached. Read more
§fn consume_unpin(&mut self, amt: usize)where
Self: Unpin,
fn consume_unpin(&mut self, amt: usize)where Self: Unpin,
§fn read_until<'a>(
&'a mut self,
byte: u8,
buf: &'a mut Vec<u8>
) -> ReadUntil<'a, Self>where
Self: Unpin,
fn read_until<'a>( &'a mut self, byte: u8, buf: &'a mut Vec<u8> ) -> ReadUntil<'a, Self>where Self: Unpin,
Creates a future which will read all the bytes associated with this I/O
object into
buf
until the delimiter byte
or EOF is reached.
This method is the async equivalent to BufRead::read_until
. Read more§fn read_line<'a>(&'a mut self, buf: &'a mut String) -> ReadLine<'a, Self>where
Self: Unpin,
fn read_line<'a>(&'a mut self, buf: &'a mut String) -> ReadLine<'a, Self>where Self: Unpin,
Creates a future which will read all the bytes associated with this I/O
object into
buf
until a newline (the 0xA byte) or EOF is reached,
This method is the async equivalent to BufRead::read_line
. Read more§fn lines(self) -> Lines<Self>where
Self: Sized,
fn lines(self) -> Lines<Self>where Self: Sized,
Returns a stream over the lines of this reader.
This method is the async equivalent to
BufRead::lines
. Read more§impl<R> AsyncReadExt for Rwhere
R: AsyncRead + ?Sized,
impl<R> AsyncReadExt for Rwhere R: AsyncRead + ?Sized,
§fn chain<R>(self, next: R) -> Chain<Self, R>where
Self: Sized,
R: AsyncRead,
fn chain<R>(self, next: R) -> Chain<Self, R>where Self: Sized, R: AsyncRead,
Creates an adaptor which will chain this stream with another. Read more
§fn read<'a>(&'a mut self, buf: &'a mut [u8]) -> Read<'a, Self>where
Self: Unpin,
fn read<'a>(&'a mut self, buf: &'a mut [u8]) -> Read<'a, Self>where Self: Unpin,
Tries to read some bytes directly into the given
buf
in asynchronous
manner, returning a future type. Read more§fn read_vectored<'a>(
&'a mut self,
bufs: &'a mut [IoSliceMut<'a>]
) -> ReadVectored<'a, Self>where
Self: Unpin,
fn read_vectored<'a>( &'a mut self, bufs: &'a mut [IoSliceMut<'a>] ) -> ReadVectored<'a, Self>where Self: Unpin,
Creates a future which will read from the
AsyncRead
into bufs
using vectored
IO operations. Read more§fn read_exact<'a>(&'a mut self, buf: &'a mut [u8]) -> ReadExact<'a, Self>where
Self: Unpin,
fn read_exact<'a>(&'a mut self, buf: &'a mut [u8]) -> ReadExact<'a, Self>where Self: Unpin,
Creates a future which will read exactly enough bytes to fill
buf
,
returning an error if end of file (EOF) is hit sooner. Read more§fn read_to_end<'a>(&'a mut self, buf: &'a mut Vec<u8>) -> ReadToEnd<'a, Self>where
Self: Unpin,
fn read_to_end<'a>(&'a mut self, buf: &'a mut Vec<u8>) -> ReadToEnd<'a, Self>where Self: Unpin,
Creates a future which will read all the bytes from this
AsyncRead
. Read more§fn read_to_string<'a>(
&'a mut self,
buf: &'a mut String
) -> ReadToString<'a, Self>where
Self: Unpin,
fn read_to_string<'a>( &'a mut self, buf: &'a mut String ) -> ReadToString<'a, Self>where Self: Unpin,
Creates a future which will read all the bytes from this
AsyncRead
. Read more§impl<W> AsyncWriteExt for Wwhere
W: AsyncWrite + ?Sized,
impl<W> AsyncWriteExt for Wwhere W: AsyncWrite + ?Sized,
§fn flush(&mut self) -> Flush<'_, Self>where
Self: Unpin,
fn flush(&mut self) -> Flush<'_, Self>where Self: Unpin,
Creates a future which will entirely flush this
AsyncWrite
. Read more§fn close(&mut self) -> Close<'_, Self>where
Self: Unpin,
fn close(&mut self) -> Close<'_, Self>where Self: Unpin,
Creates a future which will entirely close this
AsyncWrite
.§fn write<'a>(&'a mut self, buf: &'a [u8]) -> Write<'a, Self>where
Self: Unpin,
fn write<'a>(&'a mut self, buf: &'a [u8]) -> Write<'a, Self>where Self: Unpin,
Creates a future which will write bytes from
buf
into the object. Read more§fn write_vectored<'a>(
&'a mut self,
bufs: &'a [IoSlice<'a>]
) -> WriteVectored<'a, Self>where
Self: Unpin,
fn write_vectored<'a>( &'a mut self, bufs: &'a [IoSlice<'a>] ) -> WriteVectored<'a, Self>where Self: Unpin,
Creates a future which will write bytes from
bufs
into the object using vectored
IO operations. Read moresource§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more