Struct bitvec::index::BitTail

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

Semantic index of a dead bit after a live region.

Like BitIdx<R>, this type indicates a semantic counter within a register R. However, it marks the position of a dead bit after a live range. This means that it is permitted to have the value of R::BITS, to indicate that a live region touches the semantic back edge of the register R.

Instances of this type will only contain the value 0 when the span that created them is empty. Otherwise, they will have the range 1 ..= R::BITS.

This type cannot be used for indexing into a register R, and does not translate to a BitPos<R>. It has no behavior other than viewing its internal counter for region arithmetic.

Type Parameters

• R: The register type that these values govern.

Validity

Values of this type are required to be in the range 0 ..= R::BITS. Any value outside this range will cause the program state to become invalid, and the library’s behavior is unspecified. The library will never produce such an invalid value.

Construction

This type cannot be directly constructed outside the bitvec crate. bitvec will construct safe values of this type, and allows users to view them and use them for region computation. All values of this type constructed by bitvec are known to be correct based on user input to the crate.

Implementations

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

pub fn value(self) -> u8

Views the internal tail value.

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

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

Formats the value using the given formatter.

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

fn default() -> BitTail<R>

Returns the "default value" for a type.

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

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

Formats the value using the given formatter.

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

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

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

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

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

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

This method tests for !=.

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

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

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

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

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

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

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

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

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

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

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

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

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