Struct BitField

pub struct BitField<T: PrimInt>(/* private fields */);

A bitfield type.

Built on type of an unsigned integer. It uses the bits to represent the presence or absence of elements.

Implementations

impl<T: PrimInt> BitField<T>

pub fn set_bit(&mut self, bit_idx: BitFieldIndex) -> bool

Set the bit at BitFieldIndex to 1.

Does not check that the BitFieldIndex is not out of range.

Returns true if the value is changed.

pub fn set_bit_checked(&mut self, bit_idx: BitFieldIndex) -> Option<bool>

Set the bit at BitFieldIndex to 1, if the index is in range..

Check that the BitFieldIndex is not out of range. Calls set_bit if the index is in range.

Returns Some(true) if the value is changed. Returns None if the index is out of range.

pub fn unset_bit(&mut self, bit_idx: BitFieldIndex) -> bool

pub fn unset_bit_checked(&mut self, bit_idx: BitFieldIndex) -> Option<bool>

pub fn merge(&mut self, other: &Self) -> bool

impl<T: PrimInt> BitField<T>

pub fn fill(nb_bits: BitFieldSize) -> Self

pub fn fill_checked(nb_bits: BitFieldSize) -> Option<Self>

pub fn full() -> Self

pub fn empty() -> Self

pub fn single_bit(bit_idx: BitFieldIndex) -> Self

pub fn single_bit_checked(bit_idx: BitFieldIndex) -> Option<Self>

pub fn all_but_single_bit(nb_bits: BitFieldSize, bit_idx: BitFieldIndex) -> Self

pub fn all_but_single_bit_checked( nb_bits: BitFieldSize, bit_idx: BitFieldIndex, ) -> Option<Self>

pub fn all_but_single_bit_full(bit_idx: BitFieldIndex) -> Self

pub fn all_but_single_bit_full_checked(bit_idx: BitFieldIndex) -> Option<Self>

impl<T: PrimInt> BitField<T>

pub const fn into_inner(self) -> T

Consumes the BitField, returning the wrapped value.

pub fn nb_elements(&self) -> usize

Returns the number of elements present.

impl<T: PrimInt> BitField<T>

pub const SIZE: BitFieldSize

The maximum number of elements that can be tracked.

Trait Implementations

impl<T: PrimInt> BitAnd for BitField<T>

type Output = BitField<T>

The resulting type after applying the & operator.

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

Performs the & operation.

impl<T: PrimInt> BitAndAssign for BitField<T>

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl<T: PrimInt> BitOr for BitField<T>

type Output = BitField<T>

The resulting type after applying the | operator.

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

Performs the | operation.

impl<T: PrimInt> BitOrAssign for BitField<T>

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl<T: PrimInt> BitXor for BitField<T>

type Output = BitField<T>

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl<T: PrimInt> BitXorAssign for BitField<T>

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation.

impl<T: Clone + PrimInt> Clone for BitField<T>

fn clone(&self) -> BitField<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + PrimInt> Debug for BitField<T>

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

Formats the value using the given formatter.

impl<T: PrimInt> Deref for BitField<T>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T: PrimInt> DerefMut for BitField<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T: PrimInt> From<T> for BitField<T>

fn from(value: T) -> Self

Converts to this type from the input type.

impl<T: Hash + PrimInt> Hash for BitField<T>

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<T: PrimInt> Not for BitField<T>

type Output = BitField<T>

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl<T: Ord + PrimInt> Ord for BitField<T>

fn cmp(&self, other: &BitField<T>) -> 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<T: PartialEq + PrimInt> PartialEq for BitField<T>

fn eq(&self, other: &BitField<T>) -> 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<T: PartialOrd + PrimInt> PartialOrd for BitField<T>

fn partial_cmp(&self, other: &BitField<T>) -> 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<T: PrimInt> Shl<u8> for BitField<T>

type Output = BitField<T>

The resulting type after applying the << operator.

fn shl(self, rhs: u8) -> Self::Output

Performs the << operation.

impl<T: PrimInt> ShlAssign<u8> for BitField<T>

fn shl_assign(&mut self, rhs: u8)

Performs the <<= operation.

impl<T: PrimInt> Shr<u8> for BitField<T>

type Output = BitField<T>

The resulting type after applying the >> operator.

fn shr(self, rhs: u8) -> Self::Output

Performs the >> operation.

impl<T: PrimInt> ShrAssign<u8> for BitField<T>

fn shr_assign(&mut self, rhs: u8)

Performs the >>= operation.

impl<T: Copy + PrimInt> Copy for BitField<T>

impl<T: Eq + PrimInt> Eq for BitField<T>

impl<T: PrimInt> StructuralPartialEq for BitField<T>