Struct andex::Andex

pub struct Andex<const SIZE: usize>(_);

Array index generic type

This is the type of the array index that receives the size of the array as a const generic SIZE parameter.

Note: the maximum numerical value in the andex is SIZE - 1.

Example

This should be used in a type alias, as such:

use andex::*;

type MyIdx = Andex<12>;

Implementations

impl<const SIZE: usize> Andex<SIZE>

pub const SIZE: usize

The SIZE parameter, which is the size of the array that this andex indexes.

pub const fn new<const N: usize>() -> Andex<SIZE>

Create a new andex instance

Bounds are checked at compile time when this is used to create const instances - that’s why this is the recommended usage:

use andex::*;
type MyIdx = Andex<12>;

const MYVALUE : MyIdx = MyIdx::new::<0>();

And that’s why the following doesn’t compile:

use andex::*;
type MyIdx = Andex<12>;

const MYVALUE : MyIdx = MyIdx::new::<12>();

pub const fn into_usize(self) -> usize

Extracts the numeric value of the index, consuming it

pub fn iter() -> impl Iterator<Item = Andex<SIZE>>

Iterate all possible values of the index

Useful to loop over an array inside a struct, without holding a reference to the whole struct in the loop.

Example

use andex::*;

#[derive(Default)]
pub struct Scores([u32; PlayerId::SIZE]);

type PlayerId = Andex<12>;

impl_andex_for!(Scores, u32, PlayerId);

#[derive(Default)]
struct Game {
    scores: Scores,
}

fn function(game: &Game) {
    for i in PlayerId::iter() {
        println!("score of player {} is {}", i, game.scores[i]);
    }
}

pub fn index_arr<'a, T>(&self, arr: &'a [T; SIZE]) -> &'a T

Indexes the provided array

Used internally by the Index trait implementation.

pub fn index_arr_mut<'a, T>(&self, arr: &'a mut [T; SIZE]) -> &'a mut T

Mut-indexes the provided array

Used internally by the IndexMut trait implementation.

Trait Implementations

impl<const SIZE: usize> Clone for Andex<SIZE>

fn clone(&self) -> Andex<SIZE>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const SIZE: usize> Debug for Andex<SIZE>

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

Formats the value using the given formatter.

impl<const SIZE: usize> Default for Andex<SIZE>

fn default() -> Andex<SIZE>

Returns the “default value” for a type.

impl<const SIZE: usize> Display for Andex<SIZE>

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

Formats the value using the given formatter.

impl<const SIZE: usize> From<Andex<SIZE>> for usize

fn from(i: Andex<SIZE>) -> Self

Performs the conversion.

impl<const SIZE: usize> Hash for Andex<SIZE>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<const SIZE: usize> Ord for Andex<SIZE>

fn cmp(&self, other: &Andex<SIZE>) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl<const SIZE: usize> PartialEq<Andex<SIZE>> for Andex<SIZE>

fn eq(&self, other: &Andex<SIZE>) -> bool

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

fn ne(&self, other: &Andex<SIZE>) -> bool

This method tests for !=.

impl<const SIZE: usize> PartialOrd<Andex<SIZE>> for Andex<SIZE>

fn partial_cmp(&self, other: &Andex<SIZE>) -> 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<const SIZE: usize> TryFrom<usize> for Andex<SIZE>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: usize) -> Result<Self, Self::Error>

Performs the conversion.

impl<const SIZE: usize> Copy for Andex<SIZE>

impl<const SIZE: usize> Eq for Andex<SIZE>

impl<const SIZE: usize> StructuralEq for Andex<SIZE>

impl<const SIZE: usize> StructuralPartialEq for Andex<SIZE>