Struct bitvec::indices::BitMask

pub struct BitMask<T> where
    T: BitStore,  { /* private fields */ }

Wrapper type indicating a one-hot encoding of a bit mask for an element.

This type is produced by BitOrder implementations to speed up access to the underlying memory. It ensures that masks have exactly one set bit, and can safely be used as a mask for read/write access to memory.

Type Parameters

• T: The storage type being masked.

Implementations

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

pub fn new(mask: T) -> Self

Produce a new bit-mask wrapper around a one-hot mask value.

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

Parameters

• mask: The mask value to encode. This must have exactly one bit set high, and all others set low.

Returns

mask wrapped in the BitMask marker type.

Panics

This function unconditionally panics if mask has zero or multiple bits set high.

pub unsafe fn new_unchecked(mask: T) -> Self

Produce a new bit-mask wrapper around any value.

Safety

The caller must ensure that mask has exactly one bit set. BitOrder implementations should prefer ::new, which always panics on failure.

Parameters

• mask: The mask value to encode. This must have exactly one bit set. Failure to uphold this requirement will introduce uncontrolled state contamination.

Returns

mask wrapped in the BitMask marker type.

Panics

This function panics if mask has zero or multiple bits set, only in debug builds. It does not inspect mask in release builds.

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

fn default() -> BitMask<T>

Returns the “default value” for a type.

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

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

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

fn cmp(&self, other: &BitMask<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

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq<BitMask<T>> for BitMask<T> where
    T: BitStore, 

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

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

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

This method tests for !=.

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

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

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

fn lt(&self, other: &Rhs) -> bool

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

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

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

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

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

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

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