Trait Mask 

pub trait Mask:
    PrimInt
    + ConstZero
    + ConstOne
    + Bounded
    + Euclid {
    const ALL_SELECTED: Self;
    const NONE_SELECTED: Self;
    const ONE_SELECTED: Self;
    const MAX_SELECTIONS: u32;

    // Required method
    fn mask_to_indices(self) -> impl Iterator<Item = usize>;

    // Provided method
    fn index_to_mask(index: usize) -> Self { ... }
}

An integer mask trait

Required Associated Constants

const ALL_SELECTED: Self

An instance of the mask with all indices selected.

const NONE_SELECTED: Self

An instance of the mask with no indices selected.

const ONE_SELECTED: Self

An instance of the mask with the lowest index (1) selected.

const MAX_SELECTIONS: u32

The number of bits in the mask

Required Methods

fn mask_to_indices(self) -> impl Iterator<Item = usize>

Convert this mask into an iterator of indices.

Provided Methods

fn index_to_mask(index: usize) -> Self

Convert an index into an instance of this mask.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl Mask for u8

const ALL_SELECTED: Self = Self::MAX

const NONE_SELECTED: Self = 0

const ONE_SELECTED: Self = 1

const MAX_SELECTIONS: u32 = Self::BITS

fn mask_to_indices(self) -> impl Iterator<Item = usize>

impl Mask for u16

const ALL_SELECTED: Self = Self::MAX

const NONE_SELECTED: Self = 0

const ONE_SELECTED: Self = 1

const MAX_SELECTIONS: u32 = Self::BITS

fn mask_to_indices(self) -> impl Iterator<Item = usize>

impl Mask for u32

const ALL_SELECTED: Self = Self::MAX

const NONE_SELECTED: Self = 0

const ONE_SELECTED: Self = 1

const MAX_SELECTIONS: u32 = Self::BITS

fn mask_to_indices(self) -> impl Iterator<Item = usize>

impl Mask for u64

const ALL_SELECTED: Self = Self::MAX

const NONE_SELECTED: Self = 0

const ONE_SELECTED: Self = 1

const MAX_SELECTIONS: u32 = Self::BITS

fn mask_to_indices(self) -> impl Iterator<Item = usize>

impl Mask for u128

const ALL_SELECTED: Self = Self::MAX

const NONE_SELECTED: Self = 0

const ONE_SELECTED: Self = 1

const MAX_SELECTIONS: u32 = Self::BITS

fn mask_to_indices(self) -> impl Iterator<Item = usize>

Implementors