Trait futures_io::AsyncRead

pub trait AsyncRead {
    fn poll_read(
        &mut self, 
        lw: &LocalWaker, 
        buf: &mut [u8]
    ) -> Poll<Result<usize>>;

    unsafe fn initializer(&self) -> Initializer { ... }
    fn poll_vectored_read(
        &mut self, 
        lw: &LocalWaker, 
        vec: &mut [&mut IoVec]
    ) -> Poll<Result<usize>> { ... }
}

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(&mut self, lw: &LocalWaker, buf: &mut [u8]) -> Poll<Result<usize>>

Attempt to read from the AsyncRead into buf.

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

If no data is available for reading, the method returns Ok(Async::Pending) and arranges for the current task (via lw.waker()) 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 Async::Pending and either internally retry or convert Interrupted into another error kind.

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_vectored_read(
    &mut self,
    lw: &LocalWaker,
    vec: &mut [&mut IoVec]
) -> Poll<Result<usize>>

Attempt to read from the AsyncRead into vec 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 Ok(Async::Ready(num_bytes_read)).

If no data is available for reading, the method returns Ok(Async::Pending) and arranges for the current task (via lw.waker()) 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 vec. 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 Async::Pending and either internally retry or convert Interrupted into another error kind.

Implementations on Foreign Types

impl<T: ?Sized + AsyncRead> AsyncRead for Box<T>

unsafe fn initializer(&self) -> Initializer

fn poll_read(&mut self, lw: &LocalWaker, buf: &mut [u8]) -> Poll<Result<usize>>

fn poll_vectored_read(     &mut self,     lw: &LocalWaker,     vec: &mut [&mut IoVec] ) -> Poll<Result<usize>>

impl<'a, T: ?Sized + AsyncRead> AsyncRead for &'a mut T

unsafe fn initializer(&self) -> Initializer

fn poll_read(&mut self, lw: &LocalWaker, buf: &mut [u8]) -> Poll<Result<usize>>

fn poll_vectored_read(     &mut self,     lw: &LocalWaker,     vec: &mut [&mut IoVec] ) -> Poll<Result<usize>>

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

unsafe fn initializer(&self) -> Initializer

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

fn poll_vectored_read(     &mut self,     lw: &LocalWaker,     vec: &mut [&mut IoVec] ) -> Poll<Result<usize>>

impl AsyncRead for Repeat

unsafe fn initializer(&self) -> Initializer

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

fn poll_vectored_read(     &mut self,     lw: &LocalWaker,     vec: &mut [&mut IoVec] ) -> Poll<Result<usize>>

impl<T: AsRef<[u8]>> AsyncRead for Cursor<T>

unsafe fn initializer(&self) -> Initializer

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

fn poll_vectored_read(     &mut self,     lw: &LocalWaker,     vec: &mut [&mut IoVec] ) -> Poll<Result<usize>>

Implementors