Trait futures::io::AsyncBufRead

pub trait AsyncBufRead: AsyncRead {
    fn poll_fill_buf(
        self: Pin<&mut Self>, 
        cx: &mut Context
    ) -> Poll<Result<&[u8], Error>>;
    fn consume(self: Pin<&mut Self>, amt: usize);
}

Read bytes asynchronously.

This trait is analogous to the std::io::BufRead trait, but integrates with the asynchronous task system. In particular, the poll_fill_buf method, unlike BufRead::fill_buf, 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_fill_buf(
    self: Pin<&mut Self>,
    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.

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

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.

This function is a lower-level call. It needs to be paired with the consume method to function properly. When calling this method, none of the contents will be "read" in the sense that later calling poll_read may return the same contents. As such, consume must be called with the number of bytes that are consumed from this buffer to ensure that the bytes are never returned twice.

An empty buffer returned indicates that the stream has reached EOF.

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.

fn consume(self: Pin<&mut Self>, 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.

This function is a lower-level call. It needs to be paired with the poll_fill_buf method to function properly. This function does not perform any I/O, it simply informs this object that some amount of its buffer, returned from poll_fill_buf, has been consumed and should no longer be returned. As such, this function may do odd things if poll_fill_buf isn't called before calling it.

The amt must be <= the number of bytes in the buffer returned by poll_fill_buf.

Loading content...

Implementations on Foreign Types

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

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

fn consume(self: Pin<&mut &'_ mut T>, amt: usize)

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

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

fn consume(self: Pin<&mut Pin<P>>, amt: usize)

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

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

fn consume(self: Pin<&mut Box<T>>, amt: usize)

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

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

fn consume(self: Pin<&mut Cursor<T>>, amt: usize)

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

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

fn consume(self: Pin<&mut &'_ [u8]>, amt: usize)

Loading content...

Implementors

impl AsyncBufRead for Empty

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

fn consume(self: Pin<&mut Empty>, usize)

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

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

fn consume(self: Pin<&mut Either<A, B>>, amt: usize)

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

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

fn consume(self: Pin<&mut BufReader<R>>, amt: usize)

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

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

fn consume(self: Pin<&mut Take<R>>, amt: usize)

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

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

fn consume(self: Pin<&mut IntoAsyncRead<St>>, amount: usize)

impl<T> AsyncBufRead for AllowStdIo<T> where
    T: BufRead, 

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

fn consume(self: Pin<&mut AllowStdIo<T>>, amt: usize)

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

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

fn consume(self: Pin<&mut Chain<T, U>>, amt: usize)

Loading content...