snarkvm_console_types_boolean/
lib.rs

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
// Copyright 2024 Aleo Network Foundation
// This file is part of the snarkVM library.

// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at:

// http://www.apache.org/licenses/LICENSE-2.0

// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#![cfg_attr(test, allow(clippy::assertions_on_result_states))]
#![warn(clippy::cast_possible_truncation)]

mod bitwise;
mod bytes;
mod from_bits;
mod parse;
mod random;
mod serialize;
mod size_in_bits;
mod size_in_bytes;
mod to_bits;

pub use snarkvm_console_network_environment::prelude::*;

use core::marker::PhantomData;

#[derive(Copy, Clone, PartialEq, Eq, Hash)]
pub struct Boolean<E: Environment> {
    /// The underlying boolean.
    boolean: bool,
    /// PhantomData.
    _phantom: PhantomData<E>,
}

impl<E: Environment> BooleanTrait for Boolean<E> {}

impl<E: Environment> Boolean<E> {
    /// Initializes a new boolean.
    pub const fn new(boolean: bool) -> Self {
        Self { boolean, _phantom: PhantomData }
    }

    /// Initializes a `false` boolean.
    #[deprecated(since = "0.1.0", note = "This is used for **testing** purposes")]
    pub const fn zero() -> Self {
        Self::new(false)
    }
}

impl<E: Environment> TypeName for Boolean<E> {
    /// Returns the type name as a string.
    #[inline]
    fn type_name() -> &'static str {
        "boolean"
    }
}

impl<E: Environment> Deref for Boolean<E> {
    type Target = bool;

    #[inline]
    fn deref(&self) -> &Self::Target {
        &self.boolean
    }
}

impl<E: Environment> PartialEq<Boolean<E>> for bool {
    fn eq(&self, other: &Boolean<E>) -> bool {
        *self == **other
    }
}