Struct array_map::IndexU16

#[repr(transparent)]
#[must_use]
pub struct IndexU16<const N: u16>(_);

This struct implements Indexable and allows all values in 0..N

Implementations

impl<const N: u16> IndexU16<N>

#[must_use]

pub fn new(u: u16) -> Option<Self>

Returns a new IndexU8 if it is in a valid range

#[must_use]

pub fn get(self) -> u16

Returns the underlying u8

Trait Implementations

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

fn clone(&self) -> IndexU16<N>

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

fn default() -> IndexU16<N>

Returns the “default value” for a type.

impl<'de, const N: u16> Deserialize<'de> for IndexU16<N>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

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

const SIZE: usize

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

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

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

fn index(self) -> usize

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

fn iter() -> Self::Iter

An Iterator over all valid values of self

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

fn cmp(&self, other: &IndexU16<N>) -> Ordering

This method returns an Ordering between self and other.

#[must_use]

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

Compares and returns the maximum of two values.

#[must_use]

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

Compares and returns the minimum of two values.

#[must_use]

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

Restrict a value to a certain interval.

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

fn eq(&self, other: &IndexU16<N>) -> bool

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

fn ne(&self, other: &IndexU16<N>) -> bool

This method tests for !=.

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

fn partial_cmp(&self, other: &IndexU16<N>) -> Option<Ordering>

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

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

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

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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<const N: u16> ReverseIndexable for IndexU16<N>

fn from_index(u: usize) -> Self

Converts from a usize to Self

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

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

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

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

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