Struct Wrapper 

pub struct Wrapper<R> { /* private fields */ }

Wrapper is a wrapper around a reader that also computes the SHA1/ SHA256 hash of the data read.

It is designed to work with any reader that implements BufRead.

Fields:

• inner: The inner reader.
• hash: The optional hash state. None means only bytes read are counted.
• bytes_read: The number of bytes consumed from the wrapped reader.

Implementations

impl<R> Wrapper<R>

where R: BufRead,

pub fn new(inner: R) -> Self

Constructs a new Wrapper with hash tracking enabled.

Parameters

• inner: The reader to wrap.

pub fn new_without_hash(inner: R) -> Self

Constructs a wrapper that only tracks bytes read, skipping the running hash.

pub fn bytes_read(&self) -> usize

Returns the number of bytes read so far.

pub fn final_hash(&self) -> ObjectHash

Returns the final SHA1/ SHA256 hash of the data read so far.

This is a clone of the internal hash state finalized into a SHA1/ SHA256 hash.

Trait Implementations

impl<R> BufRead for Wrapper<R>

where R: BufRead,

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

Provides access to the internal buffer of the wrapped reader without consuming it.

fn consume(&mut self, amt: usize)

Consumes data from the buffer and updates the hash when tracking is enabled.

Parameters

• amt: The amount of data to consume from the buffer.

fn has_data_left(&mut self) -> Result<bool, Error>

🔬This is a nightly-only experimental API. (buf_read_has_data_left)

Checks if there is any data left to be read.

fn read_until(&mut self, byte: u8, buf: &mut Vec<u8>) -> Result<usize, Error>

Reads all bytes into buf until the delimiter byte or EOF is reached.

fn skip_until(&mut self, byte: u8) -> Result<usize, Error>

Skips all bytes until the delimiter byte or EOF is reached.

fn read_line(&mut self, buf: &mut String) -> Result<usize, Error>

Reads all bytes until a newline (the 0xA byte) is reached, and append them to the provided String buffer.

fn split(self, byte: u8) -> Split<Self>

where Self: Sized,

Returns an iterator over the contents of this reader split on the byte byte.

fn lines(self) -> Lines<Self>

where Self: Sized,

Returns an iterator over the lines of this reader.

impl<R> Read for Wrapper<R>

where R: BufRead,

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

Reads data into the provided buffer and updates the hash when tracking is enabled.
Read::read_exact calls it internally.

Parameters

• buf: The buffer to read data into.

Returns

Returns the number of bytes read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Reads all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Reads all bytes until EOF in this source, appending them to buf.

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

Reads the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_, u8>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Pull some bytes from this source into the specified buffer.

fn read_buf_exact( &mut self, cursor: BorrowedCursor<'_, u8>, ) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Reads the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Read.

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R>

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

where Self: Sized,

Creates an adapter which will read at most limit bytes from it.

fn read_array<const N: usize>(&mut self) -> Result<[u8; N], Error>

where Self: Sized,

🔬This is a nightly-only experimental API. (read_array)

Read and return a fixed array of bytes from this source.

fn read_le<T>(&mut self) -> Result<T, Error>

where T: FromEndianBytes, Self: Sized,

🔬This is a nightly-only experimental API. (read_le)

Read and return a type (e.g. an integer) in little-endian order.

fn read_be<T>(&mut self) -> Result<T, Error>

where T: FromEndianBytes, Self: Sized,

🔬This is a nightly-only experimental API. (read_le)

Read and return a type (e.g. an integer) in big-endian order.