Struct EnumSize

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

A counter between 0 and the number of values inhabiting T.

Implementations

impl<T: Enumoid> EnumSize<T>

pub const EMPTY: EnumSize<T>

pub const FULL: EnumSize<T>

pub fn from_last_value(value: T) -> Self

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

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

pub fn into_usize(&self) -> usize

pub fn into_last_value(&self) -> Option<T>

pub fn next_index(&self, index: EnumIndex<T>) -> Option<EnumIndex<T>>

Returns the next index or None.

Panics

Panics if the value is beyond the size.

pub fn next(&self, value: T) -> Option<T>

Returns the next element or None.

Panics

Panics if the value is beyond the size.

pub fn prev_index(&self, index: EnumIndex<T>) -> Option<EnumIndex<T>>

Returns the previous index or None.

Panics

Panics if the value is beyond the size.

pub fn prev(&self, value: T) -> Option<T>

Returns the previous element or None.

Panics

Panics if the value is beyond the size.

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

Returns the next index or wraps around to the beginning.

Panics

Panics if the value is beyond the size.

pub fn next_wrapped(&self, value: T) -> T

Returns the next element or wraps around to the beginning.

Panics

Panics if the value is beyond the size.

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

Returns the previous index or wraps around to the end.

Panics

Panics if the value is beyond the size.

pub fn prev_wrapped(&self, value: T) -> T

Returns the previous element or wraps around to the end.

Panics

Panics if the value is beyond the size.

pub fn contains_index(&self, index: EnumIndex<T>) -> bool

pub fn contains(&self, value: T) -> bool

pub fn iter( &self, ) -> Map<<T as Enumoid>::WordRange, fn(<T as Enumoid>::Word) -> T>

pub fn iter_until( &self, until: T, ) -> Map<<T as Enumoid>::WordRange, fn(<T as Enumoid>::Word) -> T>

pub fn iter_from( &self, from: T, ) -> Map<<T as Enumoid>::WordRange, fn(<T as Enumoid>::Word) -> T>

pub fn iter_from_until( &self, from: T, until: T, ) -> Map<<T as Enumoid>::WordRange, fn(<T as Enumoid>::Word) -> T>

Trait Implementations

impl<T: Enumoid> Clone for EnumSize<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 EnumSize<T>

where T::Word: Debug,

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

Formats the value using the given formatter.

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

where T::Word: Ord,

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

Restrict a value to a certain interval.

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

where T::Word: PartialEq,

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

Tests for self and other values to be equal, and is used by ==.

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

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

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

where T::Word: PartialOrd,

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: Enumoid> Copy for EnumSize<T>

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

where T::Word: Eq,

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