Trait BufRead

pub trait BufRead: Read {
    // Required methods
    fn fill_buf(&mut self) -> Result<&[u8]>;
    fn consume(&mut self, amount: usize);
}

A trait describing an input stream that uses an internal buffer when reading.

Required Methods

fn fill_buf(&mut self) -> Result<&[u8]>

Returns data read from this reader, filling the internal buffer if needed.

fn consume(&mut self, amount: usize)

Marks the buffered data up to amount as consumed.

Panics

May panic if amount is greater than amount of data read by fill_buf.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl BufRead for &[u8]

fn fill_buf(&mut self) -> Result<&[u8]>

fn consume(&mut self, amount: usize)

impl BufRead for VecDeque<u8>

Available on crate feature std only.

fn fill_buf(&mut self) -> Result<&[u8]>

fn consume(&mut self, amount: usize)

impl BufRead for StdinLock<'_>

Available on crate feature std only.

fn fill_buf(&mut self) -> Result<&[u8]>

fn consume(&mut self, amount: usize)

impl BufRead for Empty

Available on crate feature std only.

fn fill_buf(&mut self) -> Result<&[u8]>

fn consume(&mut self, amount: usize)

impl<R1: BufRead, R2: BufRead> BufRead for Chain<R1, R2>

Available on crate feature std only.

fn fill_buf(&mut self) -> Result<&[u8]>

fn consume(&mut self, amount: usize)

impl<R> BufRead for BufReader<R>

where R: ?Sized + Read,

Available on crate feature std only.

fn fill_buf(&mut self) -> Result<&[u8]>

fn consume(&mut self, amount: usize)

impl<R: BufRead> BufRead for Take<R>

Available on crate feature std only.

fn fill_buf(&mut self) -> Result<&[u8]>

fn consume(&mut self, amount: usize)

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

Available on crate feature std only.

fn fill_buf(&mut self) -> Result<&[u8]>

fn consume(&mut self, amount: usize)

Implementors

impl<'a, R: BufRead + ?Sized> BufRead for bitcoin_io::Take<'a, R>

impl<T: AsRef<[u8]>> BufRead for bitcoin_io::Cursor<T>

impl<T: BufRead> BufRead for FromStd<T>

Available on crate feature std only.

impl<T: BufRead> BufRead for ToStd<T>

Available on crate feature std only.