Trait bittle::Mask

pub trait Mask: Sized {
    type Iter: Iterator<Item = usize>;
    fn test(&self, index: usize) -> bool;
    fn iter(&self) -> Self::Iter;

    fn join<I>(&self, iter: I) -> Join<Self::Iter, I::IntoIter>
    where
        Self: Sized,
        I: IntoIterator,
    { ... }
}

A trait used to check if an index is masked.

Associated Types

type Iter: Iterator<Item = usize>

The iterator over a mask, indicating all items in the mask.

Required methods

fn test(&self, index: usize) -> bool

Test if the given bit is set.

fn iter(&self) -> Self::Iter

Construct an iterator over a bit set.

Provided methods

fn join<I>(&self, iter: I) -> Join<Self::Iter, I::IntoIter> where
    Self: Sized,
    I: IntoIterator, 

Join this bit set with an iterator, creating an iterator that only yields the elements which are set.

Examples

use bittle::{FixedSet, Mask};

let mask: FixedSet<u128> = bittle::fixed_set![0, 1, 3];
let mut values = vec![false, false, false, false];

for value in mask.join(values.iter_mut()) {
    *value = true;
}

assert_eq!(values, vec![true, true, false, true]);

Implementations on Foreign Types

impl<M: ?Sized> Mask for &M where
    M: Mask, 

type Iter = M::Iter

fn test(&self, index: usize) -> bool

fn iter(&self) -> Self::Iter

Implementors

impl<T> Mask for FixedSet<T> where
    T: Bits, 

type Iter = T::Iter