Struct IoStream

pub struct IoStream<St, I>
where
    St: Unpin,
{ /* private fields */ }

A wrapper over a TryStream + Sink that implements AsyncRead/AsyncWrite and AsyncBufRead. See the readme for more information.

Implements tokio::io::AsyncRead and tokio::io::AsyncWrite when the tokio_io feature is enabled.

Implementations

impl<St, I> IoStream<St, I>

where St: Unpin,

pub fn new(inner: St) -> Self

Create a new IoStream.

pub fn inner(&self) -> &St

Get a reference to the inner stream.

pub fn inner_mut(&mut self) -> &mut St

Get a mut reference to the inner stream.

Trait Implementations

impl<St, I> AsyncBufRead for IoStream<St, I>

where St: TryStream<Ok = I, Error = Error> + Unpin, I: AsRef<[u8]> + Unpin,

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>, amount: 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<St, I> AsyncRead for IoStream<St, I>

where St: TryStream<Ok = I, Error = Error> + Unpin, I: AsRef<[u8]>,

fn poll_read( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &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>>

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

impl<St, I> AsyncRead for IoStream<St, I>

where St: TryStream<Ok = I, Error = Error> + Unpin, I: AsRef<[u8]>,

Available on crate feature tokio_io only.

This impl requires the tokio_io feature.

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

Attempts to read from the AsyncRead into buf.

impl<St, I> AsyncWrite for IoStream<St, I>

where St: Sink<I, Error = Error> + Unpin, I: From<Vec<u8>>,

Errors

The following errors can be returned when writing to the stream:

• io::ErrorKind::NotConnected: This means that the connection is already closed. You should drop it. It is safe to drop the underlying connection.

• io::ErrorKind::InvalidData: This means that a tungstenite::error::Capacity occurred. This means that you send in a buffer bigger than the maximum message size configured on the underlying websocket connection. If you did not set it manually, the default for tungstenite is 64MB.

• other std::io::Error’s generally mean something went wrong on the underlying transport. Consider these fatal and just drop the connection.

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

Will always flush the underlying socket. Will always create an entire Websocket message from every write, so call with a sufficiently large buffer if you have performance problems.

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

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

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.

impl<St, I> AsyncWrite for IoStream<St, I>

where St: Sink<I, Error = Error> + Unpin, I: From<Vec<u8>>,

Available on crate feature tokio_io only.

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<()>>

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<()>>

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<St, I> Borrow<St> for IoStream<St, I>

where St: Sink<I, Error = Error> + TryStream<Ok = I, Error = Error> + Unpin,

fn borrow(&self) -> &St

Immutably borrows from an owned value.

impl<St, I> BorrowMut<St> for IoStream<St, I>

where St: Sink<I, Error = Error> + TryStream<Ok = I, Error = Error> + Unpin,

fn borrow_mut(&mut self) -> &mut St

Mutably borrows from an owned value.

impl<St: Unpin, I> Debug for IoStream<St, I>

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

Formats the value using the given formatter.

impl<St, I, Ev> Observable<Ev> for IoStream<St, I>

where St: Sink<I, Error = Error> + TryStream<Ok = I, Error = Error> + Observable<Ev> + Unpin + Send, Ev: Clone + Send + 'static, I: Send,

Available on crate feature map_pharos only.

This impl requires the map_pharos feature.

type Error = <St as Observable<Ev>>::Error

The error type that is returned if observing is not possible.

fn observe( &mut self, options: ObserveConfig<Ev>, ) -> Observe<'_, Ev, Self::Error>

Add an observer to the observable. Options allow chosing the channel type and to filter events with a predicate.

impl<St, I, Ev> ObservableLocal<Ev> for IoStream<St, I>

where St: Sink<I, Error = Error> + TryStream<Ok = I, Error = Error> + ObservableLocal<Ev> + Unpin, Ev: Clone + Send + 'static,

Available on crate feature map_pharos only.

This impl requires the map_pharos feature.

type Error = <St as ObservableLocal<Ev>>::Error

The error type that is returned if observing is not possible.

fn observe_local( &mut self, options: ObserveConfig<Ev>, ) -> ObserveLocal<'_, Ev, Self::Error>

Add an observer to the observable. Options allow chosing the channel type and to filter events with a predicate.

impl<St, I> Unpin for IoStream<St, I>

where St: Unpin,