Struct bitvec::index::BitPos

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

An electrical position counter within a register element R.

This type is a counter in the ring 0 .. R::BITS, and serves to mark an electrical address of a real bit. It is the shift distance in the expression 1 << n. It is only produced by applying a BitOrder::at transformation to some BitIdx produced by this library.

Type Parameters

• R: The register element that this position governs.

Validity

Values of this type are required to be in the range 0 .. R::BITS. Any value not less than R::BITS makes the program invalid, and will likely cause a crash. In addition, BitOrder::at has a list of requirements that its implementations must uphold in order to make construction of this type semantically correct in a program.

Construction

This type is publicly constructible. bitvec will only request its creation by calling BitOrder::at, and has no sites that can publicly accept untrusted values.

Implementations

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

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

Wraps a counter value as a known-good position within an R register.

Parameters

• value: The counter value to mark as a position. This must be in the range 0 .. R::BITS.

Returns

This returns Some(value) when it is in the valid range 0 .. R::BITS, and None when it is not.

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

Wraps a counter value as an assumed-good position within an R register.

Parameters

• value: The counter value to mark as a position. This must be in the range 0 .. R::BITS.

Returns

This returns value, marked as a valid position.

Safety

If the value is outside the valid range, then the program is incorrect. Debug builds will panic; release builds do not inspect the value.

pub fn into_inner(self) -> u8

Removes the position wrapper, leaving the internal counter.

pub fn select(self) -> BitSel<R>

Computes the bit selector corresponding to self.

This is always 1 << self.pos.

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

Computes the bit selector for self as an accessor mask.

This is a type-cast over Self::select.

Trait Implementations

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

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

Formats the value using the given formatter.

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

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

Formats the value using the given formatter.

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

fn default() -> BitPos<R>

Returns the “default value” for a type.

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

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

Formats the value using the given formatter.

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

impl<R: Hash> Hash for BitPos<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 BitPos<R> where
    R: BitRegister, 

fn cmp(&self, other: &BitPos<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<BitPos<R>> for BitPos<R> where
    R: BitRegister, 

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

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

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

This method tests for !=.

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

fn partial_cmp(&self, other: &BitPos<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> StructuralEq for BitPos<R> where
    R: BitRegister, 

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