Trait bitcoin_io::Read

pub trait Read {
    // Required method
    fn read(&mut self, buf: &mut [u8]) -> Result<usize>;

    // Provided methods
    fn read_exact(&mut self, buf: &mut [u8]) -> Result<()> { ... }
    fn take(&mut self, limit: u64) -> Take<'_, Self> { ... }
    fn read_to_limit(&mut self, buf: &mut Vec<u8>, limit: u64) -> Result<usize> { ... }
}

A generic trait describing an input stream. See std::io::Read for more info.

Required Methods

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Reads bytes from source into buf.

Provided Methods

fn read_exact(&mut self, buf: &mut [u8]) -> Result<()>

Reads bytes from source until buf is full.

fn take(&mut self, limit: u64) -> Take<'_, Self>

Creates an adapter which will read at most limit bytes.

fn read_to_limit(&mut self, buf: &mut Vec<u8>, limit: u64) -> Result<usize>

Attempts to read up to limit bytes from the reader, allocating space in buf as needed.

limit is used to prevent a denial of service attack vector since an unbounded reader will exhaust all memory.

Similar to std::io::Read::read_to_end but with the DOS protection.

Implementations on Foreign Types

impl Read for &[u8]

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

impl<R: Read> Read for BufReader<R>

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Implementors

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

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