crypto-bigint 0.7.2

Pure Rust implementation of a big integer library which has been designed from the ground-up for use in cryptographic applications. Provides constant-time, no_std-friendly implementations of modern formulas using const generics.
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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147

//! [`BoxedUint`] bitwise AND operations.

use super::BoxedUint;
use crate::{BitAnd, BitAndAssign, CtOption, Limb, Wrapping};

impl BoxedUint {
    /// Computes bitwise `a & b`.
    #[inline(always)]
    #[must_use]
    pub fn bitand(&self, rhs: &Self) -> Self {
        Self::map_limbs(self, rhs, Limb::bitand)
    }

    /// Perform bitwise `AND` between `self` and the given [`Limb`], performing the `AND` operation
    /// on every limb of `self`.
    #[must_use]
    pub fn bitand_limb(&self, rhs: Limb) -> Self {
        Self {
            limbs: self.limbs.iter().map(|limb| limb.bitand(rhs)).collect(),
        }
    }

    /// Perform wrapping bitwise `AND`.
    ///
    /// There's no way wrapping could ever happen.
    /// This function exists so that all operations are accounted for in the wrapping operations
    #[must_use]
    pub fn wrapping_and(&self, rhs: &Self) -> Self {
        self.bitand(rhs)
    }

    /// Perform checked bitwise `AND`, returning a [`CtOption`] which `is_some` always
    #[must_use]
    pub fn checked_and(&self, rhs: &Self) -> CtOption<Self> {
        CtOption::some(self.bitand(rhs))
    }
}

impl BitAnd for BoxedUint {
    type Output = Self;

    fn bitand(self, rhs: Self) -> BoxedUint {
        self.bitand(&rhs)
    }
}

impl BitAnd<&BoxedUint> for BoxedUint {
    type Output = BoxedUint;

    #[allow(clippy::needless_borrow)]
    fn bitand(self, rhs: &BoxedUint) -> BoxedUint {
        (&self).bitand(rhs)
    }
}

impl BitAnd<BoxedUint> for &BoxedUint {
    type Output = BoxedUint;

    fn bitand(self, rhs: BoxedUint) -> BoxedUint {
        self.bitand(&rhs)
    }
}

impl BitAnd<&BoxedUint> for &BoxedUint {
    type Output = BoxedUint;

    fn bitand(self, rhs: &BoxedUint) -> BoxedUint {
        self.bitand(rhs)
    }
}

impl BitAndAssign for BoxedUint {
    #[allow(clippy::assign_op_pattern)]
    fn bitand_assign(&mut self, other: Self) {
        *self = BoxedUint::bitand(self, &other);
    }
}

impl BitAndAssign<&BoxedUint> for BoxedUint {
    #[allow(clippy::assign_op_pattern)]
    fn bitand_assign(&mut self, other: &Self) {
        *self = BoxedUint::bitand(self, other);
    }
}

impl BitAnd for Wrapping<BoxedUint> {
    type Output = Self;

    fn bitand(self, rhs: Self) -> Wrapping<BoxedUint> {
        Wrapping(self.0.bitand(&rhs.0))
    }
}

impl BitAnd<&Wrapping<BoxedUint>> for Wrapping<BoxedUint> {
    type Output = Wrapping<BoxedUint>;

    fn bitand(self, rhs: &Wrapping<BoxedUint>) -> Wrapping<BoxedUint> {
        Wrapping(self.0.bitand(&rhs.0))
    }
}

impl BitAnd<Wrapping<BoxedUint>> for &Wrapping<BoxedUint> {
    type Output = Wrapping<BoxedUint>;

    fn bitand(self, rhs: Wrapping<BoxedUint>) -> Wrapping<BoxedUint> {
        Wrapping(BoxedUint::bitand(&self.0, &rhs.0))
    }
}

impl BitAnd<&Wrapping<BoxedUint>> for &Wrapping<BoxedUint> {
    type Output = Wrapping<BoxedUint>;

    fn bitand(self, rhs: &Wrapping<BoxedUint>) -> Wrapping<BoxedUint> {
        Wrapping(BoxedUint::bitand(&self.0, &rhs.0))
    }
}

impl BitAndAssign for Wrapping<BoxedUint> {
    #[allow(clippy::assign_op_pattern)]
    fn bitand_assign(&mut self, other: Self) {
        *self = Wrapping(BoxedUint::bitand(&self.0, &other.0));
    }
}

impl BitAndAssign<&Wrapping<BoxedUint>> for Wrapping<BoxedUint> {
    #[allow(clippy::assign_op_pattern)]
    fn bitand_assign(&mut self, other: &Self) {
        *self = Wrapping(BoxedUint::bitand(&self.0, &other.0));
    }
}

#[cfg(test)]
mod tests {
    use crate::BoxedUint;

    #[test]
    fn checked_and_ok() {
        let result = BoxedUint::zero().checked_and(&BoxedUint::one());
        assert_eq!(result.unwrap(), BoxedUint::zero());
    }

    #[test]
    fn overlapping_and_ok() {
        let result = BoxedUint::max(128).wrapping_and(&BoxedUint::one());
        assert_eq!(result, BoxedUint::one());
    }
}