Trait array_map::Indexable

pub unsafe trait Indexable {
    type Iter: Iterator<Item = Self>;

    const SIZE: usize;
    const SET_SIZE: usize;

    fn index(self) -> usize;
    fn iter() -> Self::Iter;
}

Allows mapping from a type to an index

Safety

This trait is unsafe because there are a few other requirements that need to be met:

• The indexes of self need to be contiguous and need to be returned in order from iter()
• Iter needs to return exactly N items (this is checked in debug mode)

Associated Types

type Iter: Iterator<Item = Self>

The type of Iterator that will be returned by Self::iter()

Associated Constants

const SIZE: usize

The number of items or variants that this type can have.

const SET_SIZE: usize

The number of bytes it will take to represent this type in a set.

Safety

This must equal set_size(Self::SIZE)

Required methods

fn index(self) -> usize

Maps self to usize to know which value in the underling array to use

Safety

This value can never be greater than Self::SIZE

All values in 0..SIZE must be returned by some variant of self.

fn iter() -> Self::Iter

An Iterator over all valid values of self

Safety

This iterator must yield exactly Self::SIZE items

Implementations on Foreign Types

impl<T, U, V> Indexable for (T, U, V) where
    T: Indexable + Clone,
    U: Indexable + Clone,
    V: Indexable, 

const SIZE: usize

const SET_SIZE: usize

type Iter = ThreeTupleIter<T, U, V>

fn index(self) -> usize

fn iter() -> Self::Iter

impl<T, U> Indexable for (T, U) where
    T: Indexable + Clone,
    U: Indexable, 

const SIZE: usize

const SET_SIZE: usize

type Iter = TwoTupleIter<T, U>

fn index(self) -> usize

fn iter() -> Self::Iter

impl<T: Indexable> Indexable for Option<T>

const SIZE: usize

const SET_SIZE: usize

type Iter = Chain<Map<T::Iter, fn(_: T) -> Option<T>>, Once<Option<T>>>

fn index(self) -> usize

fn iter() -> Self::Iter

impl Indexable for bool

const SIZE: usize

const SET_SIZE: usize

type Iter = IntoIter<bool, 2>

fn index(self) -> usize

fn iter() -> Self::Iter

impl Indexable for u8

const SIZE: usize

const SET_SIZE: usize

type Iter = RangeInclusive<Self>

fn index(self) -> usize

fn iter() -> Self::Iter

impl Indexable for u16

const SIZE: usize

const SET_SIZE: usize

type Iter = RangeInclusive<Self>

fn index(self) -> usize

fn iter() -> Self::Iter

Implementors

impl<const N: u8> Indexable for IndexU8<N>

const SIZE: usize

const SET_SIZE: usize

type Iter = Map<Range<u8>, fn(_: u8) -> Self>

impl<const N: u16> Indexable for IndexU16<N>

const SIZE: usize

const SET_SIZE: usize

type Iter = Map<Range<u16>, fn(_: u16) -> Self>