1// Copyright 2024 Brian Smith.
2//
3// Permission to use, copy, modify, and/or distribute this software for any
4// purpose with or without fee is hereby granted, provided that the above
5// copyright notice and this permission notice appear in all copies.
6//
7// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
8// WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
9// MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
10// SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
11// WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
12// OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
13// CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
14
15use super::Word;
16use core::ops;
17
18// BoolMask is either `BoolMask::TRUE` or `BoolMask::FALSE`.
19#[repr(transparent)]
20pub struct BoolMask(Word);
21
22impl BoolMask {
23 #[cfg(test)]
24 pub(super) const TRUE: Self = Self(Word::MAX);
25 #[cfg(test)]
26 pub(super) const FALSE: Self = Self(0);
27
28 /// Returns true if `self` is `BoolMask::TRUE`; otherwise, returns false
29 /// (`self` is `BoolMask::FALSE`).
30 pub(crate) fn leak(self) -> bool {
31 self.0 != 0
32 }
33}
34
35impl ops::BitAnd for BoolMask {
36 type Output = Self;
37
38 fn bitand(self, rhs: Self) -> Self {
39 Self(self.0 & rhs.0)
40 }
41}
42