Struct BufBitcoinReader

struct BufBitcoinReader<'a, R: Read> {
    inner: &'a mut R,
    buf: [u8; 1],
    is_consumed: bool,
}

Wrap buffering support for implementations of Read. A reader which keeps an internal buffer to avoid hitting the underlying stream directly for every read.

In order to avoid reading bytes past the first object, and those bytes then ending up getting dropped, this BufBitcoinReader operates in one-byte-increments.

This code is vendored from the lightning crate: https://github.com/lightningdevkit/rust-lightning/blob/5718baaed947fcaa9c60d80cdf309040c0c68489/lightning/src/util/ser.rs#L72-L138

Fields

inner: &'a mut R

buf: [u8; 1]

is_consumed: bool

Implementations

impl<'a, R: Read> BufBitcoinReader<'a, R>

fn new(inner: &'a mut R) -> Self

Creates a BufBitcoinReader which will read from the given inner.

Trait Implementations

impl<'a, R: Read> BufRead for BufBitcoinReader<'a, R>

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.

impl<'a, R: Read> Read for BufBitcoinReader<'a, R>

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

Reads bytes from source into buf.

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

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, Error>

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