Struct fog_crypto::hash::HashState

pub struct HashState { /* fields omitted */ }

A hasher that can incrementally take in data and produce a hash at any time.

Example

// Create a hash by feeding in bytes repeatedly
let mut hash_state = HashState::new();
hash_state.update(b"I am the first part of a data sequence");
let hash_first = hash_state.hash(); // Produce a hash of just the first part
hash_state.update(b"And I am their sibling, the second part of a data sequence");
let hash_full = hash_state.finalize(); // Consume the HashState
println!("hash_first(Base58): {}", hash_first);
println!("hash_full(Base58): {}", hash_full);

Implementations

impl HashState

pub fn new() -> HashState

Initialize a new hasher.

pub fn with_version(version: u8) -> Result<HashState, CryptoError>

Initialize a new hasher with a specific algorithm version. You should avoid this except when working through an upgrade process, where you may briefly need to support more than one version. Fails if the version isn’t supported.

pub fn version(&self) -> u8

Get the version of hash that this hasher will produce on completion.

pub fn update(&mut self, data: impl AsRef<[u8]>)

Update the hasher with new input data.

pub fn hash(&self) -> Hash

Get the hash of the data fed into the algorithm so far.

pub fn finalize(self) -> Hash

Finalize the hasher and produce a hash. Functions like hash() but consumes the state.

Trait Implementations

impl Clone for HashState

fn clone(&self) -> HashState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HashState

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

Formats the value using the given formatter.

impl Default for HashState

fn default() -> Self

Returns the “default value” for a type.