Struct enumoid::EnumIndex

pub struct EnumIndex<T: Enumoid>(/* private fields */);

A counter between 0 and the highest index into the values inhabiting T.

Implementations

impl<T: Enumoid> EnumIndex<T>

pub fn from_usize(sz: usize) -> Option<Self>

pub fn from_value(value: T) -> Self

pub fn into_value(self) -> T

pub fn into_word(self) -> T::Word

pub fn into_usize(self) -> usize

pub fn next(self) -> Option<Self>

Returns the next index or None.

pub fn prev(self) -> Option<Self>

Returns the previous index or None.

pub fn next_wrapped(self) -> Self

Returns the next index or wraps around to the beginning.

pub fn prev_wrapped(self) -> Self

Returns the previous index or wraps around to the end.

Trait Implementations

impl<T: Enumoid> Clone for EnumIndex<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Enumoid> Debug for EnumIndex<T>

where T::Word: Debug,

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

Formats the value using the given formatter.

impl<T: Enumoid> From<T> for EnumIndex<T>

fn from(value: T) -> Self

Converts to this type from the input type.

impl<T: EnumArrayHelper<V>, V> Index<EnumIndex<T>> for EnumMap<T, V>

type Output = V

The returned type after indexing.

fn index(&self, index: EnumIndex<T>) -> &V

Performs the indexing (container[index]) operation.

impl<T: EnumArrayHelper<V>, V> Index<EnumIndex<T>> for EnumVec<T, V>

type Output = V

The returned type after indexing.

fn index(&self, index: EnumIndex<T>) -> &V

Performs the indexing (container[index]) operation.

impl<T: EnumArrayHelper<V>, V> IndexMut<EnumIndex<T>> for EnumMap<T, V>

fn index_mut(&mut self, index: EnumIndex<T>) -> &mut V

Performs the mutable indexing (container[index]) operation.

impl<T: EnumArrayHelper<V>, V> IndexMut<EnumIndex<T>> for EnumVec<T, V>

fn index_mut(&mut self, index: EnumIndex<T>) -> &mut V

Performs the mutable indexing (container[index]) operation.

impl<T: Ord + Enumoid> Ord for EnumIndex<T>

where T::Word: Ord,

fn cmp(&self, other: &EnumIndex<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<T: PartialEq + Enumoid> PartialEq for EnumIndex<T>

where T::Word: PartialEq,

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: PartialOrd + Enumoid> PartialOrd for EnumIndex<T>

where T::Word: PartialOrd,

fn partial_cmp(&self, other: &EnumIndex<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: Enumoid> Copy for EnumIndex<T>

impl<T: Eq + Enumoid> Eq for EnumIndex<T>

where T::Word: Eq,

impl<T: Enumoid> StructuralPartialEq for EnumIndex<T>