Struct andex::Andex

pub struct Andex<M, const SIZE: usize>(/* private fields */);

Array index generic type

This generic type receives a user-specified “marker” type as the first type parameter to make it unique, and the size of the array as a second const generic SIZE parameter.

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

Recommended usage, with an empty type as a marker to create a type alias:

use andex::*;

enum MyIdxMarker {}
type MyIdx = Andex<MyIdxMarker, 12>;

Implementations

impl<M, const SIZE: usize> Andex<M, SIZE>

Andex-wide methods

Andex::new and Andex::iter are public, most other methods are only used in traits, and thus private.

pub const SIZE: usize = SIZE

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

pub const FIRST: Andex<M, SIZE> = _

The first possible value.

pub const LAST: Andex<M, SIZE> = _

The last possible value.

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

Create a new andex instance

We recomment using this method in const contexts, passing the index as a const generic function parameter. That allows the compiler to check the index against the array bounds at compile time.

For instance, the following compiles:

use andex::*;

struct MyIdxMarker;
type MyIdx = Andex<MyIdxMarker, 12>;

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

While the following doesn’t:

use andex::*;

struct MyIdxMarker;
type MyIdx = Andex<MyIdxMarker, 13>;

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

pub const fn pair(self) -> Self

Returns the pair of the provided Andex.

The “pair” is the element that is at the same distance from the center. This definition is useful in some contexts. For instance, the pair of Self::FIRST is Self::LAST.

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

Return the next Andex in sequence, or None if it’s the last one.

pub fn iter() -> AndexIterator<M, 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

This prints all numbers from 0 to 11:

use andex::*;

pub struct PlayerIdMarker;
type PlayerId = Andex<PlayerIdMarker, 12>;

for i in PlayerId::iter() {
    println!("{}", i);
}

Trait Implementations

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

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

fn default() -> Self

Returns the “default value” for a type.

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

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

Formats the value using the given formatter.

impl<M, const SIZE: usize> From<&Andex<M, SIZE>> for usize

fn from(andex: &Andex<M, SIZE>) -> Self

Converts to this type from the input type.

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

fn from(andex: Andex<M, SIZE>) -> Self

Converts to this type from the input type.

impl<M, const SIZE: usize> FromStr for Andex<M, SIZE>

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl<A, Item, const SIZE: usize> Index<&Andex<A, SIZE>> for AndexableArray<Andex<A, SIZE>, Item, SIZE>

type Output = Item

The returned type after indexing.

fn index(&self, index: &Andex<A, SIZE>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<A, Item, const SIZE: usize> Index<Andex<A, SIZE>> for AndexableArray<Andex<A, SIZE>, Item, SIZE>

type Output = Item

The returned type after indexing.

fn index(&self, index: Andex<A, SIZE>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<A, Item, const SIZE: usize> IndexMut<&Andex<A, SIZE>> for AndexableArray<Andex<A, SIZE>, Item, SIZE>

fn index_mut(&mut self, index: &Andex<A, SIZE>) -> &mut Item

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

impl<A, Item, const SIZE: usize> IndexMut<Andex<A, SIZE>> for AndexableArray<Andex<A, SIZE>, Item, SIZE>

fn index_mut(&mut self, index: Andex<A, SIZE>) -> &mut Item

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

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

fn cmp(&self, other: &Self) -> 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<M, const SIZE: usize> PartialEq for Andex<M, SIZE>

fn eq(&self, other: &Self) -> 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<M, const SIZE: usize> PartialOrd for Andex<M, SIZE>

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

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