Struct HashReader

pub struct HashReader<R>
where
    R: Read,
{ /* private fields */ }

Available on crate feature std and little-endian only.

Hash Reader

Notes

• You can make this struct via Hash.

• For each call to read():

  • The inner reader will be called first. If an error occurs, it will be returned. The hasher will not be updated.
  • Then the hasher will be updated.

Examples

use {
    std::io::Read,
    zeros::keccak::Hash,
};

const DATA: &[u8] = b"test";
const HASH: Hash = Hash::Sha3_256;

let mut buf = Vec::new();
let mut reader = HASH.new_reader(DATA);
reader.read_to_end(&mut buf)?;

let (hash, _) = reader.finish();
assert_eq!(hash, HASH.hash(DATA));
assert_eq!(buf, DATA);

Implementations

impl<R> HashReader<R>

where R: Read,

pub fn finish(self) -> (Vec<u8>, R)

Finishes and returns hash and the inner reader

pub fn finish_as_hex(self) -> (String, R)

Finishes and returns hash as a hexadecimal string, in lower-case, and the inner reader

pub fn into_inner(self) -> R

Drops the hasher and returns inner reader

Trait Implementations

impl<R> Debug for HashReader<R>

where R: Read + Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<R> Read for HashReader<R>

where R: Read,

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

Pull some bytes from this source into the specified buffer, returning how many bytes were 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<'_>) -> 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<'_>) -> 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” adaptor 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.