Struct bitvec::indices::BitPos

pub struct BitPos<T> where
    T: BitStore,  { /* fields omitted */ }

Indicates a real electrical index within an element.

This type is produced by BitOrder implementors, and marks a specific electrical bit within a memory element, rather than BitIdx’s semantic bit.

Type Parameters

• T: A BitStore element which provides bounds-checking information. The new constructor uses T::BITS to ensure that constructed BitPos instances are always valid to use within T elements.

Methods

impl<T> BitPos<T> where
    T: BitStore, 

pub fn new(pos: u8) -> Self

Produce a new bit position marker at a valid position value.

BitOrder implementations should prefer this method, but may use ::new_unchecked if they can guarantee that the range invariant is upheld.

Parameters

• pos: The bit position value to encode. It must be in the range 0 .. T::BITS.

Panics

This function panics if pos is greater than or equal to T::BITS.

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

Produce a new bit position marker at any position value.

Safety

The caller must ensure that pos is less than T::BITS. BitOrder implementations should prefer ::new, which panics on range failure.

Parameters

• pos: The bit position value to encode. This must be in the range 0 .. T::BITS.

Returns

pos wrapped in the BitPos marker type.

Panics

This function panics if pos is greater than or equal to T::BITS, but only in debug builds. It does not inspect pos in release builds.

Trait Implementations

impl<T: Clone> Clone for BitPos<T> where
    T: BitStore, 

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Copy> Copy for BitPos<T> where
    T: BitStore, 

impl<T: Debug> Debug for BitPos<T> where
    T: BitStore, 

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

Formats the value using the given formatter.

impl<T: Default> Default for BitPos<T> where
    T: BitStore, 

fn default() -> BitPos<T>

Returns the "default value" for a type.

impl<T> Deref for BitPos<T> where
    T: BitStore, 

type Target = u8

The resulting type after dereferencing.

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

Dereferences the value.

impl<T: Eq> Eq for BitPos<T> where
    T: BitStore, 

impl<T: Hash> Hash for BitPos<T> where
    T: BitStore, 

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<T: Ord> Ord for BitPos<T> where
    T: BitStore, 

fn cmp(&self, other: &BitPos<T>) -> 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<T: PartialEq> PartialEq<BitPos<T>> for BitPos<T> where
    T: BitStore, 

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

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

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

This method tests for !=.

impl<T: PartialOrd> PartialOrd<BitPos<T>> for BitPos<T> where
    T: BitStore, 

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

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

fn lt(&self, other: &BitPos<T>) -> bool

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

fn le(&self, other: &BitPos<T>) -> bool

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

fn gt(&self, other: &BitPos<T>) -> bool

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

fn ge(&self, other: &BitPos<T>) -> bool

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

impl<T> StructuralEq for BitPos<T> where
    T: BitStore, 

impl<T> StructuralPartialEq for BitPos<T> where
    T: BitStore,