Struct bitvec::index::BitSel

#[repr(transparent)]
pub struct BitSel<R> where
    R: BitRegister,  { /* fields omitted */ }

A one-hot selection mask for a register element R.

This type selects exactly one bit in a register. It is used to apply test and write operations into memory.

Type Parameters

• R: The register element this selector governs.

Validity

Values of this type are required to have exactly one bit set high, and all others set low.

Construction

This type is only constructed from the BitPos::select and BitOrder::select functions. It is always equivalent to 1 << BitPos::unwrap.

The chain of custody, from known-good BitIdx values, through proven-good BitOrder implementations, into BitPos and then BitSel, proves that values of this type are always correct to apply to underlying memory.

Implementations

impl<R> BitSel<R> where
    R: BitRegister, 

pub fn new(value: R) -> Option<Self>

Wraps a counter value as a known-good selection of an R register.

Parameters

• value: A one-hot selection mask of a bit in an R register.

Returns

If value is a power of two (exactly one bit set high and all others set low), it returns Some of a BitSel wrapping the value.

pub unsafe fn new_unchecked(value: R) -> Self

Wraps a counter value as an assumed-good selection of an R register.

Parameters

• value: A one-hot selection mask of a bit in an R register.

Returns

value wrapped in a BitSel.

Safety

value must be a power of two: one bit set high and all others set low. In debug builds, invalid values cause a panic; release builds do not check the input.

This function must only be called in a BitOrder::select implementation that is verified to be correct.

pub fn value(self) -> R

Removes the selector wrapper, leaving the internal counter.

pub fn mask(self) -> BitMask<R>

Computes a bit-mask for self. This is a type-cast.

pub fn range_all(
) -> impl Iterator<Item = Self> + DoubleEndedIterator + ExactSizeIterator + FusedIterator

Iterates over all possible selector values.

Trait Implementations

impl<R> Binary for BitSel<R> where
    R: BitRegister, 

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

Formats the value using the given formatter.

impl<R: Clone> Clone for BitSel<R> where
    R: BitRegister, 

fn clone(&self) -> BitSel<R>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<R> Debug for BitSel<R> where
    R: BitRegister, 

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

Formats the value using the given formatter.

impl<R: Default> Default for BitSel<R> where
    R: BitRegister, 

fn default() -> BitSel<R>

Returns the “default value” for a type.

impl<R> Display for BitSel<R> where
    R: BitRegister, 

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

Formats the value using the given formatter.

impl<R: Hash> Hash for BitSel<R> where
    R: BitRegister, 

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl<R: Ord> Ord for BitSel<R> where
    R: BitRegister, 

fn cmp(&self, other: &BitSel<R>) -> Ordering

This method returns an Ordering between self and other.

#[must_use]

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

Compares and returns the maximum of two values.

#[must_use]

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

Compares and returns the minimum of two values.

#[must_use]

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

Restrict a value to a certain interval.

impl<R: PartialEq> PartialEq<BitSel<R>> for BitSel<R> where
    R: BitRegister, 

fn eq(&self, other: &BitSel<R>) -> bool

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

fn ne(&self, other: &BitSel<R>) -> bool

This method tests for !=.

impl<R: PartialOrd> PartialOrd<BitSel<R>> for BitSel<R> where
    R: BitRegister, 

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

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

#[must_use]

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

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

#[must_use]

pub 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]

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

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

#[must_use]

pub 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<R> Sum<BitSel<R>> for BitMask<R> where
    R: BitRegister, 

fn sum<I>(iter: I) -> Self where
    I: Iterator<Item = BitSel<R>>, 

Method which takes an iterator and generates Self from the elements by “summing up” the items.

impl<R: Copy> Copy for BitSel<R> where
    R: BitRegister, 

impl<R: Eq> Eq for BitSel<R> where
    R: BitRegister, 

impl<R> StructuralEq for BitSel<R> where
    R: BitRegister, 

impl<R> StructuralPartialEq for BitSel<R> where
    R: BitRegister,