Enum Bit 

pub enum Bit {
    Zero,
    One,
}

Enum representing all possible states of a bit in a Bitset. Variants are re-exported and don’t require Bit:: prefix.

Closely resembles bool type. Implements From<bool>, and bool implements From<Bit>, if such conversion is needed.

Examples

use bitworks::{bit::*, prelude::{Bitset, Bitset8}};

assert_eq!(!One, Zero);
assert_eq!(One | Zero, One);
assert_eq!(One & Zero, Zero);
assert_eq!(One ^ Zero, One);
assert_eq!(One ^ One, Zero);

let bitset = Bitset8::NONE
    .replace(0.try_into()?, One)
    .build();

assert_eq!(bitset.into_inner(), 0b00000001);

Variants

Zero

Also known as unset state of the bit.

One

Also known as set state of the bit.

Trait Implementations

impl<'a, T> AsMut<Bit> for BitMut<'a, T>

where T: Bitset + 'a, Self: 'a,

fn as_mut(&mut self) -> &mut Bit

Converts this type into a mutable reference of the (usually inferred) input type.

impl<'a, T> AsRef<Bit> for BitMut<'a, T>

where T: Bitset + 'a, Self: 'a,

fn as_ref(&self) -> &Bit

Converts this type into a shared reference of the (usually inferred) input type.

impl<'a, T> AsRef<Bit> for BitRef<'a, T>

where T: Bitset + 'a, Self: 'a,

fn as_ref(&self) -> &Bit

Converts this type into a shared reference of the (usually inferred) input type.

impl BitAnd for Bit

type Output = Bit

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitAndAssign for Bit

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl BitOr for Bit

type Output = Bit

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOrAssign for Bit

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl BitXor for Bit

type Output = Bit

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl BitXorAssign for Bit

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation.

impl Clone for Bit

fn clone(&self) -> Bit

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Bit

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

Formats the value using the given formatter.

impl Display for Bit

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

Formats the value using the given formatter.

impl From<Bit> for bool

fn from(value: Bit) -> Self

Converts to this type from the input type.

impl From<bool> for Bit

fn from(value: bool) -> Self

Converts to this type from the input type.

impl FromIterator<Bit> for Bitset128

fn from_iter<T: IntoIterator<Item = Bit>>(iter: T) -> Self

Creates a value from an iterator.

impl FromIterator<Bit> for Bitset16

fn from_iter<T: IntoIterator<Item = Bit>>(iter: T) -> Self

Creates a value from an iterator.

impl FromIterator<Bit> for Bitset32

fn from_iter<T: IntoIterator<Item = Bit>>(iter: T) -> Self

Creates a value from an iterator.

impl FromIterator<Bit> for Bitset64

fn from_iter<T: IntoIterator<Item = Bit>>(iter: T) -> Self

Creates a value from an iterator.

impl FromIterator<Bit> for Bitset8

fn from_iter<T: IntoIterator<Item = Bit>>(iter: T) -> Self

Creates a value from an iterator.

impl<const N: usize> FromIterator<Bit> for Byteset<N>

fn from_iter<T: IntoIterator<Item = Bit>>(iter: T) -> Self

Creates a value from an iterator.

impl Hash for Bit

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 Not for Bit

type Output = Bit

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl Ord for Bit

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Bit

fn eq(&self, other: &Bit) -> 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 PartialOrd for Bit

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for Bit

impl Eq for Bit

impl StructuralPartialEq for Bit