Skip to main content

HashReader

Struct HashReader 

Source
pub struct HashReader<D: Digest, R: Read> { /* private fields */ }
Expand description

Abstraction over a reader which hashes the data being read

Implementations§

Source§

impl<D: Digest, R: Read> HashReader<D, R>

Source

pub fn new(reader: R) -> Self

Construct a new HashReader given an existing reader by value.

Source

pub fn new_from_parts(hasher: D, reader: R) -> Self

Construct a new HashReader given an existing hasher and reader by value.

Source

pub fn replace_reader(&mut self, reader: R)

Replace the reader with another reader

Source

pub fn get_hasher(&self) -> &D

Gets a reference to the underlying hasher

Source

pub fn get_reader(&self) -> &R

Gets a reference to the underlying reader

Source

pub fn get_hasher_mut(&mut self) -> &mut D

Gets a mutable reference to the underlying hasher

Source

pub fn get_reader_mut(&mut self) -> &mut R

Gets a mutable reference to the underlying reader Direct reads from the underlying reader are not hashed

Source

pub fn into_hasher(self) -> D

Consume the HashReader and return its hasher

Source

pub fn into_inner_reader(self) -> R

Consume the HashReader and return its internal reader

Source

pub fn into_parts(self) -> (D, R)

Consume the HashReader and return its hasher and internal reader

Source

pub fn finalize(self) -> Output<D>

Retrieve result and consume HashReader instance.

Source

pub fn finalize_into(self, out: &mut Output<D>)

Write result into provided array and consume the HashReader instance.

Source

pub fn output_size() -> usize

Get output size of the hasher

Source§

impl<D: Digest + FixedOutputReset, R: Read> HashReader<D, R>

Source

pub fn finalize_reset(&mut self) -> Output<D>

Retrieve result and reset hasher instance.

Source

pub fn finalize_into_reset(&mut self, out: &mut Output<D>)

Rrite result into provided array and reset the hasher instance.

Source§

impl<D: Digest, R: BufRead> HashReader<D, R>

Source

pub fn hash_to_end(&mut self)

Read and hash all bytes remaining in the reader, discarding the data Based on implementation in b2sum crate, MIT License Copyright (c) 2017 John Downey

Trait Implementations§

Source§

impl<D: Digest + Clone, R: Read + Clone> Clone for HashReader<D, R>

Source§

fn clone(&self) -> HashReader<D, R>

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<D: Debug + Digest, R: Debug + Read> Debug for HashReader<D, R>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<D: Digest, R: Read> Read for HashReader<D, R>

Source§

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

Pull some bytes from this source into the specified buffer, returning how many bytes were read. Read more
1.36.0 · Source§

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

Like read, except that it reads into a slice of buffers. Read more
Source§

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. Read more
1.0.0 · Source§

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. Read more
1.0.0 · Source§

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

Reads all bytes until EOF in this source, appending them to buf. Read more
1.6.0 · Source§

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

Reads the exact number of bytes required to fill buf. Read more
Source§

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. Read more
Source§

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. Read more
1.0.0 · Source§

fn by_ref(&mut self) -> &mut Self
where Self: Sized,

Creates a “by reference” adapter for this instance of Read. Read more
1.0.0 · Source§

fn bytes(self) -> Bytes<Self>
where Self: Sized,

Transforms this Read instance to an Iterator over its bytes. Read more
1.0.0 · Source§

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

Creates an adapter which will chain this stream with another. Read more
1.0.0 · Source§

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

Creates an adapter which will read at most limit bytes from it. Read more
Source§

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. Read more
Source§

impl<D: Digest + Reset, R: Read> Reset for HashReader<D, R>

Source§

fn reset(&mut self)

Reset state to its initial value.

Auto Trait Implementations§

§

impl<D, R> Freeze for HashReader<D, R>
where R: Freeze, D: Freeze,

§

impl<D, R> RefUnwindSafe for HashReader<D, R>

§

impl<D, R> Send for HashReader<D, R>
where R: Send, D: Send,

§

impl<D, R> Sync for HashReader<D, R>
where R: Sync, D: Sync,

§

impl<D, R> Unpin for HashReader<D, R>
where R: Unpin, D: Unpin,

§

impl<D, R> UnsafeUnpin for HashReader<D, R>
where R: UnsafeUnpin, D: UnsafeUnpin,

§

impl<D, R> UnwindSafe for HashReader<D, R>
where R: UnwindSafe, D: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.