bab_rs 0.6.0

An implementation of the Bab family of hash functions, and its WILLIAM3 instantiation.
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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111

use order_theory::{
    GreatestElement, LeastElement, LowerSemilattice, PredecessorExceptForLeast,
    SuccessorExceptForGreatest, TryPredecessor, TrySuccessor, UpperSemilattice,
};

use crate::{WIDTH, generic::BabDigest};

/// A WILLIAM3 digest of a string.
#[derive(PartialEq, Eq, PartialOrd, Ord, Clone, Debug, Hash)]
#[cfg_attr(feature = "dev", derive(arbitrary::Arbitrary))]
#[repr(transparent)]
pub struct William3Digest(pub(crate) BabDigest<WIDTH>);

impl William3Digest {
    /// Converts `self` into the underlying byte array.
    ///
    /// This type deliberately does not provide this functionality through a trait, in order to make it less likely to leak values secrets.
    pub fn into_bytes(self) -> [u8; WIDTH] {
        self.0.into_bytes()
    }

    /// Returns a reference to the underlying byte array.
    ///
    /// This type deliberately does not provide this functionality through a trait, in order to make it less likely to leak values secrets.
    pub fn as_bytes(&self) -> &[u8; WIDTH] {
        self.0.as_bytes()
    }

    /// Returns a mutable reference to the underlying byte array.
    ///
    /// This type deliberately does not provide this functionality through a trait, in order to make it less likely to leak values secrets.
    pub fn as_mut_bytes(&mut self) -> &mut [u8; WIDTH] {
        self.0.as_mut_bytes()
    }
}

impl From<BabDigest<WIDTH>> for William3Digest {
    fn from(value: BabDigest<WIDTH>) -> Self {
        Self(value)
    }
}

impl From<[u8; WIDTH]> for William3Digest {
    fn from(value: [u8; WIDTH]) -> Self {
        Self(value.into())
    }
}

impl From<William3Digest> for BabDigest<WIDTH> {
    fn from(value: William3Digest) -> Self {
        value.0
    }
}

impl AsRef<BabDigest<WIDTH>> for William3Digest {
    fn as_ref(&self) -> &BabDigest<WIDTH> {
        &self.0
    }
}

impl AsMut<BabDigest<WIDTH>> for William3Digest {
    fn as_mut(&mut self) -> &mut BabDigest<WIDTH> {
        &mut self.0
    }
}

impl Default for William3Digest {
    fn default() -> Self {
        <BabDigest<WIDTH>>::default().into()
    }
}

impl LeastElement for William3Digest {
    fn least() -> Self {
        <BabDigest<WIDTH>>::least().into()
    }
}

impl GreatestElement for William3Digest {
    fn greatest() -> Self {
        <BabDigest<WIDTH>>::greatest().into()
    }
}

impl LowerSemilattice for William3Digest {
    fn greatest_lower_bound(&self, other: &Self) -> Self {
        self.0.greatest_lower_bound(other.as_ref()).into()
    }
}

impl UpperSemilattice for William3Digest {
    fn least_upper_bound(&self, other: &Self) -> Self {
        self.0.least_upper_bound(other.as_ref()).into()
    }
}

impl TryPredecessor for William3Digest {
    fn try_predecessor(&self) -> Option<Self> {
        self.0.try_predecessor().map(Self)
    }
}

impl TrySuccessor for William3Digest {
    fn try_successor(&self) -> Option<Self> {
        self.0.try_successor().map(Self)
    }
}

impl PredecessorExceptForLeast for William3Digest {}

impl SuccessorExceptForGreatest for William3Digest {}