Struct AsyncStream 

pub struct AsyncStream<S> { /* private fields */ }

Available on crate features io and compat only.

A stream wrapper for [futures_util::io] traits.

Implementations

impl<S> AsyncStream<S>

pub fn new(stream: S) -> AsyncStream<S>

Create AsyncStream with the stream and default buffer size.

pub fn with_capacity(cap: usize, stream: S) -> AsyncStream<S>

Create AsyncStream with the stream and buffer size.

pub fn get_ref(&self) -> &S

Get the reference of the inner stream.

impl<S> AsyncStream<S>

where S: AsyncRead + 'static,

pub fn poll_read_uninit( self: Pin<&mut AsyncStream<S>>, cx: &mut Context<'_>, buf: &mut [MaybeUninit<u8>], ) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into buf.

On success, returns Poll::Ready(Ok(num_bytes_read)).

Trait Implementations

impl<S> AsyncBufRead for AsyncStream<S>

where S: AsyncRead + 'static,

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

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 AsyncStream<S>>, 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> AsyncRead for AsyncStream<S>

where S: AsyncRead + 'static,

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

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> AsyncWrite for AsyncStream<S>

where S: AsyncWrite + 'static,

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

Attempt to write bytes from buf into the object.

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

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

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

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> Debug for AsyncStream<S>

where S: Debug,

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

Formats the value using the given formatter.