slahasher 0.5.0

Hashing functions
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

use std::sync::Arc;

use base_xx::{SerialiseError, byte_vec::TryIntoByteVec};

use crate::{Hash, HashAlgorithm};

/// Hashable trait
pub trait Hashable
where
    Self: TryIntoByteVec,
{
    /// Encodes this type using the specified `Encoding`.
    ///
    /// # Parameters
    /// * `value` - The value to encode
    /// * `encoding` - The encoding to use when encoding this type.
    ///
    /// # Returns
    /// A `Result` containing the encoded string if successful, or a `SerialiseError` if an error occurs.
    ///
    /// # Errors
    /// * `SerialiseError` - If the specified encoding is unsupported or an error occurs during serialisation.
    #[must_use = "The result of this function is a `Result` containing the encoded string if successful, or a `SerialiseError` if an error occurs."]
    fn try_hash(value: Arc<Self>, algorithm: HashAlgorithm) -> Result<Arc<Hash>, SerialiseError> {
        match Self::try_into_byte_vec(value) {
            Ok(bytes) => Hash::try_hash(bytes, algorithm),
            Err(error) => Err(error),
        }
    }
}