Struct Boolean

pub struct Boolean<E>
where
    E: Environment,
{ /* private fields */ }

Implementations

impl<E> Boolean<E>

where E: Environment,

pub const fn new(boolean: bool) -> Boolean<E>

Initializes a new boolean.

pub const fn zero() -> Boolean<E>

👎Deprecated since 0.1.0: This is used for testing purposes

Initializes a false boolean.

Trait Implementations

impl<E> BitAnd<&Boolean<E>> for Boolean<E>

where E: Environment,

fn bitand( self, other: &Boolean<E>, ) -> <Boolean<E> as BitAnd<&Boolean<E>>>::Output

Returns the bitwise AND of self and other.

type Output = Boolean<E>

The resulting type after applying the & operator.

impl<E> BitAnd for Boolean<E>

where E: Environment,

fn bitand(self, other: Boolean<E>) -> <Boolean<E> as BitAnd>::Output

Returns the bitwise AND`` of selfandother`.

type Output = Boolean<E>

The resulting type after applying the & operator.

impl<E> BitAndAssign for Boolean<E>

where E: Environment,

fn bitand_assign(&mut self, other: Boolean<E>)

Sets self as the bitwise AND of self and other.

impl<E> BitOr<&Boolean<E>> for Boolean<E>

where E: Environment,

fn bitor(self, other: &Boolean<E>) -> <Boolean<E> as BitOr<&Boolean<E>>>::Output

Returns the bitwise OR of self and other.

type Output = Boolean<E>

The resulting type after applying the | operator.

impl<E> BitOr for Boolean<E>

where E: Environment,

fn bitor(self, other: Boolean<E>) -> <Boolean<E> as BitOr>::Output

Returns the bitwise OR of self and other.

type Output = Boolean<E>

The resulting type after applying the | operator.

impl<E> BitOrAssign for Boolean<E>

where E: Environment,

fn bitor_assign(&mut self, other: Boolean<E>)

Sets self as the bitwise OR of self and other.

impl<E> BitXor<&Boolean<E>> for Boolean<E>

where E: Environment,

fn bitxor( self, other: &Boolean<E>, ) -> <Boolean<E> as BitXor<&Boolean<E>>>::Output

Returns the bitwise XOR of self and other.

type Output = Boolean<E>

The resulting type after applying the ^ operator.

impl<E> BitXor for Boolean<E>

where E: Environment,

fn bitxor(self, other: Boolean<E>) -> <Boolean<E> as BitXor>::Output

Returns the bitwise XOR of self and other.

type Output = Boolean<E>

The resulting type after applying the ^ operator.

impl<E> BitXorAssign for Boolean<E>

where E: Environment,

fn bitxor_assign(&mut self, other: Boolean<E>)

Sets self as the bitwise XOR of self and other.

impl<E: Environment> Cast<Address<E>> for Boolean<E>

fn cast(&self) -> Result<Address<E>>

Casts a Boolean to an Address.

impl<E: Environment> Cast<Boolean<E>> for Field<E>

fn cast(&self) -> Result<Boolean<E>>

Casts a Field to a Boolean, if the field is zero or one.

To cast arbitrary field elements to booleans, use Field::cast_lossy.

impl<E: Environment, I: IntegerType> Cast<Boolean<E>> for Integer<E, I>

fn cast(&self) -> Result<Boolean<E>>

Casts an Integer to a Boolean, if the integer is zero or one.

To cast arbitrary integers to booleans, use Integer::cast_lossy.

impl<E: Environment> Cast<Boolean<E>> for Scalar<E>

fn cast(&self) -> Result<Boolean<E>>

Casts a Scalar to a Boolean, if the scalar is zero or one.

To cast arbitrary scalars to booleans, use Scalar::cast_lossy.

impl<E: Environment> Cast<Field<E>> for Boolean<E>

fn cast(&self) -> Result<Field<E>>

Casts a Boolean to a Field.

impl<E: Environment> Cast<Group<E>> for Boolean<E>

fn cast(&self) -> Result<Group<E>>

Casts a Boolean to a Group.

impl<E: Environment, I: IntegerType> Cast<Integer<E, I>> for Boolean<E>

fn cast(&self) -> Result<Integer<E, I>>

Casts a Boolean to an Integer.

impl<E: Environment> Cast<Scalar<E>> for Boolean<E>

fn cast(&self) -> Result<Scalar<E>>

Casts a Boolean to a Scalar.

impl<E: Environment> Cast for Boolean<E>

fn cast(&self) -> Result<Boolean<E>>

Casts a Boolean to a Boolean.

impl<E: Environment> CastLossy<Address<E>> for Boolean<E>

fn cast_lossy(&self) -> Address<E>

Casts a Boolean to an Address. This is safe because casting from a boolean to any other type is always lossless.

If the boolean is true, the address is the generator of the prime-order subgroup. If the boolean is false, the address is the zero group element.

impl<E: Environment> CastLossy<Boolean<E>> for Field<E>

fn cast_lossy(&self) -> Boolean<E>

Casts a Field to a Boolean, with lossy truncation. This operation returns the least significant bit of the field.

impl<E: Environment, I: IntegerType> CastLossy<Boolean<E>> for Integer<E, I>

fn cast_lossy(&self) -> Boolean<E>

Casts an Integer to a Boolean, with lossy truncation. This operation returns the least significant bit of the field.

impl<E: Environment> CastLossy<Boolean<E>> for Scalar<E>

fn cast_lossy(&self) -> Boolean<E>

Casts a Scalar to a Boolean, with lossy truncation. This operation returns the least significant bit of the field.

impl<E: Environment> CastLossy<Field<E>> for Boolean<E>

fn cast_lossy(&self) -> Field<E>

Casts a Boolean to a Field. This is safe because casting from a boolean to any other type is always lossless.

impl<E: Environment> CastLossy<Group<E>> for Boolean<E>

fn cast_lossy(&self) -> Group<E>

Casts a Boolean to a Group. This is safe because casting from a boolean to any other type is always lossless.

If the boolean is true, the group element is the generator of the prime-order subgroup. If the boolean is false, the group element is the zero group element.

impl<E: Environment, I: IntegerType> CastLossy<Integer<E, I>> for Boolean<E>

fn cast_lossy(&self) -> Integer<E, I>

Casts a Boolean to an Integer.

impl<E: Environment> CastLossy<Scalar<E>> for Boolean<E>

fn cast_lossy(&self) -> Scalar<E>

Casts a Boolean to a Scalar. This is safe because casting from a boolean to any other type is always lossless.

impl<E: Environment> CastLossy for Boolean<E>

fn cast_lossy(&self) -> Boolean<E>

Casts a Boolean to a Boolean. This is an identity cast, so it is always lossless.

impl<E> Clone for Boolean<E>

where E: Clone + Environment,

fn clone(&self) -> Boolean<E>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<E> Debug for Boolean<E>

where E: Environment,

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<E> Deref for Boolean<E>

where E: Environment,

type Target = bool

The resulting type after dereferencing.

fn deref(&self) -> &<Boolean<E> as Deref>::Target

Dereferences the value.

impl<'de, E> Deserialize<'de> for Boolean<E>

where E: Environment,

fn deserialize<D>( deserializer: D, ) -> Result<Boolean<E>, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserializes the boolean from a string or bytes.

impl<E> Display for Boolean<E>

where E: Environment,

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<E> Distribution<Boolean<E>> for Standard

where E: Environment,

fn sample<R>(&self, rng: &mut R) -> Boolean<E>

where R: Rng + ?Sized,

Generate a random value of T, using rng as the source of randomness.

fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T>

where R: Rng, Self: Sized,

Create an iterator that generates random values of T, using rng as the source of randomness.

fn map<F, S>(self, func: F) -> DistMap<Self, F, T, S>

where F: Fn(T) -> S, Self: Sized,

Create a distribution of values of ‘S’ by mapping the output of Self through the closure F

impl<E> Equal for Boolean<E>

where E: Environment,

fn is_equal(&self, other: &Boolean<E>) -> <Boolean<E> as Equal>::Output

Returns true if self and other are equal.

fn is_not_equal(&self, other: &Boolean<E>) -> <Boolean<E> as Equal>::Output

Returns true if self and other are not equal.

type Output = Boolean<E>

impl<E> FromBits for Boolean<E>

where E: Environment,

fn from_bits_le(bits_le: &[bool]) -> Result<Boolean<E>, Error>

Initializes a new boolean by extracting the first bit from a list of length 1.

fn from_bits_be(bits_be: &[bool]) -> Result<Boolean<E>, Error>

Initializes a new boolean by extracting the first bit from a list of length 1.

impl<E> FromBytes for Boolean<E>

where E: Environment,

fn read_le<R>(reader: R) -> Result<Boolean<E>, Error>

where R: Read,

Reads the boolean from a buffer.

fn from_bytes_le(bytes: &[u8]) -> Result<Self, Error>

where Self: Sized,

Returns Self from a byte array in little-endian order.

impl<E> FromStr for Boolean<E>

where E: Environment,

fn from_str(string: &str) -> Result<Boolean<E>, Error>

Parses a string into a boolean.

type Err = Error

The associated error which can be returned from parsing.

impl<E> Hash for Boolean<E>

where E: Hash + Environment,

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<E> Nand for Boolean<E>

where E: Environment,

fn nand(&self, other: &Boolean<E>) -> <Boolean<E> as Nand>::Output

Returns the bitwise NAND of self and other.

type Output = Boolean<E>

impl<E> Nor for Boolean<E>

where E: Environment,

fn nor(&self, other: &Boolean<E>) -> <Boolean<E> as Nor>::Output

Returns the bitwise NOR of self and other.

type Output = Boolean<E>

impl<E> Not for Boolean<E>

where E: Environment,

fn not(self) -> <Boolean<E> as Not>::Output

Returns the negation of self.

type Output = Boolean<E>

The resulting type after applying the ! operator.

impl<E> Parser for Boolean<E>

where E: Environment,

fn parse(string: &str) -> Result<(&str, Boolean<E>), Err<VerboseError<&str>>>

Parses a string into a boolean.

impl<E> PartialEq<Boolean<E>> for bool

where E: Environment,

fn eq(&self, other: &Boolean<E>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<E> PartialEq for Boolean<E>

where E: PartialEq + Environment,

fn eq(&self, other: &Boolean<E>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<E> Serialize for Boolean<E>

where E: Environment,

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serializes the boolean into a string or as bytes.

impl<E> SizeInBits for Boolean<E>

where E: Environment,

fn size_in_bits() -> usize

Returns the field size in bits.

impl<E> SizeInBytes for Boolean<E>

where E: Environment,

fn size_in_bytes() -> usize

Returns the boolean size in bytes.

impl<E> SizeInDataBits for Boolean<E>

where E: Environment,

fn size_in_data_bits() -> usize

Returns the field capacity for data bits.

impl<E> Ternary for Boolean<E>

where E: Environment,

fn ternary( condition: &<Boolean<E> as Ternary>::Boolean, first: &Boolean<E>, second: &Boolean<E>, ) -> <Boolean<E> as Ternary>::Output

Returns first if condition is true, otherwise returns second.

type Boolean = Boolean<E>

type Output = Boolean<E>

impl<E> ToBits for Boolean<E>

where E: Environment,

fn write_bits_le(&self, vec: &mut Vec<bool>)

Outputs self in a vector.

fn write_bits_be(&self, vec: &mut Vec<bool>)

Outputs self in a vector.

fn to_bits_le(&self) -> Vec<bool>

Returns self as a boolean array in little-endian order.

fn to_bits_be(&self) -> Vec<bool>

Returns self as a boolean array in big-endian order.

fn num_bits() -> Option<usize>

An optional indication of how many bits an object can be represented with.

impl<E> ToBytes for Boolean<E>

where E: Environment,

fn write_le<W>(&self, writer: W) -> Result<(), Error>

where W: Write,

Writes the boolean to a buffer.

fn to_bytes_le(&self) -> Result<Vec<u8>, Error>

where Self: Sized,

Returns self as a byte array in little-endian order.

impl<E> TypeName for Boolean<E>

where E: Environment,

fn type_name() -> &'static str

Returns the type name as a string.

impl<E> BooleanTrait for Boolean<E>

where E: Environment,

impl<E> Copy for Boolean<E>

where E: Copy + Environment,

impl<E> Eq for Boolean<E>

where E: Eq + Environment,

impl<E> StructuralPartialEq for Boolean<E>

where E: Environment,