Trait embedded_io::asynch::BufRead

pub trait BufRead: Io {
    type FillBufFuture<'a>: Future<Output = Result<&'a [u8], Self::Error>>
    where
        Self: 'a;

    fn fill_buf<'a>(&'a mut self) -> Self::FillBufFuture<'a>;
    fn consume(&mut self, amt: usize);
}

Available on crate feature async only.

Async buffered reader.

Semantics are the same as std::io::BufRead, check its documentation for details.

Required Associated Types

type FillBufFuture<'a>: Future<Output = Result<&'a [u8], Self::Error>>
where
    Self: 'a

Future returned by fill_buf.

Required Methods

fn fill_buf<'a>(&'a mut self) -> Self::FillBufFuture<'a>

Return the contents of the internal buffer, filling it with more data from the inner reader if it is empty.

fn consume(&mut self, amt: usize)

Tell this buffer that amt bytes have been consumed from the buffer, so they should no longer be returned in calls to fill_buf.

Implementations on Foreign Types

impl<T: ?Sized + BufRead> BufRead for &mut T

type FillBufFuture<'a>
where
    Self: 'a = impl Future<Output = Result<&'a [u8], <&mut T as Io>::Error>>

fn fill_buf<'a>(&'a mut self) -> Self::FillBufFuture<'a>

fn consume(&mut self, amt: usize)

impl BufRead for &[u8]

type FillBufFuture<'a>
where
    Self: 'a = impl Future<Output = Result<&'a [u8], <&[u8] as Io>::Error>>

fn fill_buf<'a>(&'a mut self) -> Self::FillBufFuture<'a>

fn consume(&mut self, amt: usize)

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

Available on crate features std or alloc only.

type FillBufFuture<'a>
where
    Self: 'a = impl Future<Output = Result<&'a [u8], <Box<T, Global> as Io>::Error>>

fn fill_buf<'a>(&'a mut self) -> Self::FillBufFuture<'a>

fn consume(&mut self, amt: usize)

Implementors