Struct Boolean

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

Implementations

impl<E: Environment> Boolean<E>

pub const fn new(boolean: bool) -> Self

Initializes a new boolean.

pub const fn zero() -> Self

👎Deprecated since 0.1.0: This is used for testing purposes

Initializes a false boolean.

Trait Implementations

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

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

Returns the bitwise AND of self and other.

type Output = Boolean<E>

The resulting type after applying the & operator.

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

fn bitand(self, other: Self) -> Self::Output

Returns the bitwise AND`` of selfandother`.

type Output = Boolean<E>

The resulting type after applying the & operator.

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

fn bitand_assign(&mut self, other: Self)

Sets self as the bitwise AND of self and other.

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

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

Returns the bitwise OR of self and other.

type Output = Boolean<E>

The resulting type after applying the | operator.

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

fn bitor(self, other: Self) -> Self::Output

Returns the bitwise OR of self and other.

type Output = Boolean<E>

The resulting type after applying the | operator.

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

fn bitor_assign(&mut self, other: Self)

Sets self as the bitwise OR of self and other.

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

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

Returns the bitwise XOR of self and other.

type Output = Boolean<E>

The resulting type after applying the ^ operator.

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

fn bitxor(self, other: Self) -> Self::Output

Returns the bitwise XOR of self and other.

type Output = Boolean<E>

The resulting type after applying the ^ operator.

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

fn bitxor_assign(&mut self, other: Self)

Sets self as the bitwise XOR of self and other.

impl<E: Clone + Environment> Clone for Boolean<E>

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: Environment> Debug for Boolean<E>

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

Formats the value using the given formatter.

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

type Target = bool

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

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

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

Deserializes the boolean from a string or bytes.

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

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

Formats the value using the given formatter.

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

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

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: Environment> Equal for Boolean<E>

fn is_equal(&self, other: &Self) -> Self::Output

Returns true if self and other are equal.

fn is_not_equal(&self, other: &Self) -> Self::Output

Returns true if self and other are not equal.

type Output = Boolean<E>

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

fn from_bits_le(bits_le: &[bool]) -> Result<Self>

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

fn from_bits_be(bits_be: &[bool]) -> Result<Self>

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

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

fn read_le<R: Read>(reader: R) -> IoResult<Self>

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: Environment> FromStr for Boolean<E>

fn from_str(string: &str) -> Result<Self>

Parses a string into a boolean.

type Err = Error

The associated error which can be returned from parsing.

impl<E: Hash + Environment> Hash for Boolean<E>

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

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: Environment> Nand for Boolean<E>

fn nand(&self, other: &Self) -> Self::Output

Returns the bitwise NAND of self and other.

type Output = Boolean<E>

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

fn nor(&self, other: &Self) -> Self::Output

Returns the bitwise NOR of self and other.

type Output = Boolean<E>

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

fn not(self) -> Self::Output

Returns the negation of self.

type Output = Boolean<E>

The resulting type after applying the ! operator.

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

fn parse(string: &str) -> ParserResult<'_, Self>

Parses a string into a boolean.

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

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 + Environment> PartialEq for Boolean<E>

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: Environment> Serialize for Boolean<E>

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

Serializes the boolean into a string or as bytes.

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

fn size_in_bits() -> usize

Returns the field size in bits.

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

fn size_in_bytes() -> usize

Returns the boolean size in bytes.

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

fn size_in_data_bits() -> usize

Returns the field capacity for data bits.

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

fn ternary( condition: &Self::Boolean, first: &Self, second: &Self, ) -> Self::Output

Returns first if condition is true, otherwise returns second.

type Boolean = Boolean<E>

type Output = Boolean<E>

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

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: Environment> ToBytes for Boolean<E>

fn write_le<W: Write>(&self, writer: W) -> IoResult<()>

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: Environment> TypeName for Boolean<E>

fn type_name() -> &'static str

Returns the type name as a string.

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

impl<E: Copy + Environment> Copy for Boolean<E>

impl<E: Eq + Environment> Eq for Boolean<E>

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