scsys-crypto 0.3.2

cryptographic primitives and utilities for the scsys ecosystem
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

/*
    Appellation: hasher <module>
    Contrib: @FL03
*/

/// A [`Hasher`] defines a common interface for defining specific hashing algorithm.
pub trait Hasher {
    /// the output type of the hasher
    type Output;
    /// reset the hasher to its initial state
    fn clean(&mut self) -> &mut Self;
    /// finalize the hash and return the result
    fn finish(&self) -> crate::Result<Self::Output>;
    /// update the hasher with new data
    fn include(&mut self, data: impl AsRef<[u8]>) -> &mut Self;
}

/*
 ************* Implementations *************
*/
#[cfg(feature = "blake3")]
use crate::hash::H256;

#[cfg(feature = "blake3")]
impl Hasher for blake3::Hasher {
    type Output = H256;

    fn clean(&mut self) -> &mut Self {
        self.reset()
    }

    fn finish(&self) -> crate::Result<Self::Output> {
        // finalize the `blake3` hasher
        let hash = self.finalize();
        // convert the hash into the defined type before returning it
        Ok(hash.into())
    }

    fn include(&mut self, data: impl AsRef<[u8]>) -> &mut Self {
        self.update(data.as_ref())
    }
}