Enum bool::Bool

pub enum Bool {
    False,
    True,
}

Enum with two possible values: True or False which represent the logical values true and false respectively.

Variants

False

True

Methods

impl Bool

pub fn new(value: bool) -> Self

Creates a Bool dependent on the given primitive bool. If the value is true, it will return Bool::True and if the value isfalse will return Bool::False

pub fn and<R: Into<Self>>(self, rhs: R) -> Self

The logical and operation.

Truth table:

self	rhs	output
True	True	True
True	False	False
False	True	False
False	False	False

pub fn or<R: Into<Self>>(self, rhs: R) -> Self

The logical or operation.

Truth table:

self	rhs	output
True	True	True
True	False	True
False	True	True
False	False	False

pub fn not(self) -> Self

The logical not operation.

Truth table:

self	output
True	False
False	True

pub fn implication<R: Into<Self>>(self, rhs: R) -> Self

The logical [implication] operation.

Truth table:

self	rhs	output
True	True	True
True	False	False
False	True	True
False	False	True

pub fn xor<R: Into<Self>>(self, rhs: R) -> Self

The logical xor operation.

Truth table:

self	rhs	output
True	True	False
True	False	True
False	True	True
False	False	False

pub fn equivalence<R: Into<Self>>(self, rhs: R) -> Self

The logical equivalence operation.

Truth table:

self	rhs	output
True	True	True
True	False	False
False	True	False
False	False	True

pub fn is_true(self) -> bool

pub fn is_false(self) -> bool

pub fn then_some<T>(self, then: T) -> Option<T>

pub fn then<T>(self, f: impl FnOnce() -> T) -> Option<T>

Trait Implementations

impl BitAnd<Bool> for Bool

type Output = Self

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitAndAssign<Bool> for Bool

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl BitOr<Bool> for Bool

type Output = Self

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOrAssign<Bool> for Bool

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl BitXor<Bool> for Bool

type Output = Self

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl BitXorAssign<Bool> for Bool

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation.

impl Clone for Bool

fn clone(&self) -> Bool

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Bool

impl Debug for Bool

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

Formats the value using the given formatter.

impl Default for Bool

The default for Bool is False.

fn default() -> Self

Returns the "default value" for a type.

impl Eq for Bool

impl<'_> From<&'_ Bool> for bool

fn from(item: &Bool) -> Self

Performs the conversion.

impl<'_> From<&'_ mut Bool> for bool

fn from(item: &mut Bool) -> Self

Performs the conversion.

impl From<Bool> for bool

fn from(item: Bool) -> Self

Performs the conversion.

impl From<bool> for Bool

fn from(item: bool) -> Self

Performs the conversion.

impl Not for Bool

type Output = Self

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl Ord for Bool

fn cmp(&self, other: &Bool) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use] fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use] fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use] fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Bool> for Bool

fn eq(&self, other: &Bool) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<Bool> for Bool

fn partial_cmp(&self, other: &Bool) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use] fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use] fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use] fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use] fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for Bool

impl StructuralPartialEq for Bool