Struct bitvec::indices::BitIdx

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

Indicates a semantic index of a bit within a memory element.

This type is consumed by BitOrder implementors, which use it to produce a concrete bit position inside an element.

BitIdx is a semantic counter which has a defined, constant, and predictable ordering. Values of BitIdx refer strictly to an abstract ordering, and not to any actual bit positions within a memory element, so BitIdx::<T>(0) is always the first bit counted within an element, but is not required to be the most or least significant bits, or any other particular bits. Which specific bit is referred by a BitIdx value is governed by implementors of BitOrder.

Type Parameters

• T: The memory element type controlled by this index.

Methods

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

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

Wraps a counter value as a known-good index of the T element type.

Parameters

• idx: A semantic index within a T memory element.

Returns

If idx is within the range 0 .. T::BITS, then this returns the index value wrapped in the index type; if idx exceeds this range, then this returns None.

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

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

Formats the value using the given formatter.

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

fn default() -> BitIdx<T>

Returns the "default value" for a type.

impl<T> Deref for BitIdx<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 BitIdx<T> where
    T: BitStore, 

impl<T: Hash> Hash for BitIdx<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 BitIdx<T> where
    T: BitStore, 

fn cmp(&self, other: &BitIdx<T>) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

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

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

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

This method tests for !=.

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

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

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

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

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

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

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

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

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

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

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

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

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

impl<T> TryFrom<u8> for BitIdx<T> where
    T: BitStore, 

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(idx: u8) -> Result<Self, Self::Error>

Performs the conversion.