Struct bitvec::index::BitSel

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

A one-hot selection mask, to be applied to a register R.

This type selects exactly one bit, and is produced by the conversion of a semantic BitIdx to a BitPos through a BitOrder implementation, and then applying 1 << pos. Values of this type are used to select only the bit specified by a BitIdx when performing memory operations.

Type Parameters

• R: The register type that these values govern.

Validity

Values of this type are required to have exactly one bit set to 1 and all other bits set to 0.

Construction

This type is only constructed from BitPos values, which are themselves only constructed by a chain of known-good BitIdx values passed into known-correct BitOrder implementations. As such, bitvec can use BitSel values with full confidence that they are correct in the surrounding context.

Implementations

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

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

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

Parameters

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

Returns

If sel does not have exactly one bit set, this returns None; otherwise, it returns a BitSel wrapping the sel value.

Safety

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

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

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

Parameters

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

Returns

sel wrapped in a BitSel.

Safety

sel must have exactly one bit set high and all others low. In debug builds, invalid sel values cause a panic; release builds do not check the input.

This function must only be called in a correct BitOrder::select implementation.

pub fn mask(self) -> BitMask<R> where
    R: BitRegister, 

Converts the selector into a bit mask.

This is a type-cast.

pub fn value(self) -> R

Views the internal selector value.

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

Ranges 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.

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

Performs copy-assignment from source.

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

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: Eq> Eq for BitSel<R> where
    R: BitRegister, 

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.

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

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

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

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

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

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

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

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

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

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

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

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.