Trait futures::prelude::AsyncRead

pub trait AsyncRead {
    fn poll_read(
        self: Pin<&mut Self>, 
        cx: &mut Context, 
        buf: &mut [u8]
    ) -> Poll<Result<usize, Error>>;

    unsafe fn initializer(&self) -> Initializer { ... }
    fn poll_read_vectored(
        self: Pin<&mut Self>, 
        cx: &mut Context, 
        bufs: &mut [IoSliceMut]
    ) -> Poll<Result<usize, Error>> { ... }
}

Read bytes asynchronously.

This trait is analogous to the std::io::Read trait, but integrates with the asynchronous task system. In particular, the poll_read method, unlike Read::read, will automatically queue the current task for wakeup and return if data is not yet available, rather than blocking the calling thread.

Required methods

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

Attempt to read from the AsyncRead into buf.

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

If no data is available for reading, the method returns Poll::Pending and arranges for the current task (via cx.waker().wake_by_ref()) to receive a notification when the object becomes readable or is closed.

Implementation

This function may not return errors of kind WouldBlock or Interrupted. Implementations must convert WouldBlock into Poll::Pending and either internally retry or convert Interrupted into another error kind.

Loading content...

Provided methods

unsafe fn initializer(&self) -> Initializer

Determines if this AsyncReader can work with buffers of uninitialized memory.

The default implementation returns an initializer which will zero buffers.

Safety

This method is unsafe because and AsyncReader could otherwise return a non-zeroing Initializer from another AsyncRead type without an unsafe block.

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.

This method is similar to poll_read, but allows data to be read into multiple buffers using a single operation.

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

If no data is available for reading, the method returns Poll::Pending and arranges for the current task (via cx.waker().wake_by_ref()) to receive a notification when the object becomes readable or is closed. By default, this method delegates to using poll_read on the first buffer in bufs. Objects which support vectored IO should override this method.

Implementation

This function may not return errors of kind WouldBlock or Interrupted. Implementations must convert WouldBlock into Poll::Pending and either internally retry or convert Interrupted into another error kind.

Loading content...

Implementations on Foreign Types

impl<P> AsyncRead for Pin<P> where
    P: DerefMut + Unpin,
    <P as Deref>::Target: AsyncRead, 

unsafe fn initializer(&self) -> Initializer

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

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

impl<'_, T> AsyncRead for &'_ mut T where
    T: AsyncRead + Unpin + ?Sized, 

unsafe fn initializer(&self) -> Initializer

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

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

impl<'_> AsyncRead for &'_ [u8]

unsafe fn initializer(&self) -> Initializer

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

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

impl<T> AsyncRead for Cursor<T> where
    T: Unpin + AsRef<[u8]>, 

unsafe fn initializer(&self) -> Initializer

fn poll_read(
    self: Pin<&mut Cursor<T>>,
    &mut Context,
    buf: &mut [u8]
) -> Poll<Result<usize, Error>>

fn poll_read_vectored(
    self: Pin<&mut Cursor<T>>,
    &mut Context,
    bufs: &mut [IoSliceMut]
) -> Poll<Result<usize, Error>>

impl<T> AsyncRead for Box<T> where
    T: AsyncRead + Unpin + ?Sized, 

unsafe fn initializer(&self) -> Initializer

fn poll_read(
    self: Pin<&mut Box<T>>,
    cx: &mut Context,
    buf: &mut [u8]
) -> Poll<Result<usize, Error>>

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

Loading content...

Implementors

impl AsyncRead for Empty

fn poll_read(
    self: Pin<&mut Empty>,
    &mut Context,
    &mut [u8]
) -> Poll<Result<usize, Error>>

unsafe fn initializer(&self) -> Initializer

impl AsyncRead for Repeat

fn poll_read(
    self: Pin<&mut Repeat>,
    &mut Context,
    buf: &mut [u8]
) -> Poll<Result<usize, Error>>

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

unsafe fn initializer(&self) -> Initializer

impl<A, B> AsyncRead for Either<A, B> where
    A: AsyncRead,
    B: AsyncRead, 

unsafe fn initializer(&self) -> Initializer

fn poll_read(
    self: Pin<&mut Either<A, B>>,
    cx: &mut Context,
    buf: &mut [u8]
) -> Poll<Result<usize, Error>>

fn poll_read_vectored(
    self: Pin<&mut Either<A, B>>,
    cx: &mut Context,
    bufs: &mut [IoSliceMut]
) -> Poll<Result<usize, Error>>

impl<R> AsyncRead for Compat01As03<R> where
    R: AsyncRead, 

unsafe fn initializer(&self) -> Initializer

fn poll_read(
    self: Pin<&mut Compat01As03<R>>,
    cx: &mut Context,
    buf: &mut [u8]
) -> Poll<Result<usize, Error>>

impl<R> AsyncRead for BufReader<R> where
    R: AsyncRead, 

fn poll_read(
    self: Pin<&mut BufReader<R>>,
    cx: &mut Context,
    buf: &mut [u8]
) -> Poll<Result<usize, Error>>

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

unsafe fn initializer(&self) -> Initializer

impl<R> AsyncRead for ReadHalf<R> where
    R: AsyncRead, 

fn poll_read(
    self: Pin<&mut ReadHalf<R>>,
    cx: &mut Context,
    buf: &mut [u8]
) -> Poll<Result<usize, Error>>

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

impl<R> AsyncRead for Take<R> where
    R: AsyncRead, 

fn poll_read(
    self: Pin<&mut Take<R>>,
    cx: &mut Context,
    buf: &mut [u8]
) -> Poll<Result<usize, Error>>

unsafe fn initializer(&self) -> Initializer

impl<St> AsyncRead for IntoAsyncRead<St> where
    St: TryStream<Error = Error> + Unpin,
    <St as TryStream>::Ok: AsRef<[u8]>, 

fn poll_read(
    self: Pin<&mut IntoAsyncRead<St>>,
    cx: &mut Context,
    buf: &mut [u8]
) -> Poll<Result<usize, Error>>

impl<T> AsyncRead for AllowStdIo<T> where
    T: Read, 

fn poll_read(
    self: Pin<&mut AllowStdIo<T>>,
    &mut Context,
    buf: &mut [u8]
) -> Poll<Result<usize, Error>>

fn poll_read_vectored(
    self: Pin<&mut AllowStdIo<T>>,
    &mut Context,
    bufs: &mut [IoSliceMut]
) -> Poll<Result<usize, Error>>

unsafe fn initializer(&self) -> Initializer

impl<T, U> AsyncRead for Chain<T, U> where
    T: AsyncRead,
    U: AsyncRead, 

fn poll_read(
    self: Pin<&mut Chain<T, U>>,
    cx: &mut Context,
    buf: &mut [u8]
) -> Poll<Result<usize, Error>>

fn poll_read_vectored(
    self: Pin<&mut Chain<T, U>>,
    cx: &mut Context,
    bufs: &mut [IoSliceMut]
) -> Poll<Result<usize, Error>>

unsafe fn initializer(&self) -> Initializer

Loading content...