Struct andex::AndexableArray

pub struct AndexableArray<A, Item, const SIZE: usize>(/* private fields */);

Array wrapper indexable by the provided Andex type.

Example:

use andex::*;

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

// Create the array wrapper:
type MyU32 = AndexableArray<MyIdx, u32, { MyIdx::SIZE }>;

// We can create other arrays with the same Andex type:
type MyF64 = AndexableArray<MyIdx, f64, { MyIdx::SIZE }>;

// Create a default array:
let myu32 = MyU32::default();
// Print the first element:
const first : MyIdx = MyIdx::new::<0>();
println!("{:?}", myu32[first]);
// Iterate and print all elements:
for i in MyIdx::iter() {
    println!("{:?}", myu32[i]);
}
// Print the whole array
println!("{:?}", myu32);

Implementations

impl<A, Item, const SIZE: usize> AndexableArray<A, Item, SIZE>

pub fn iter(&self) -> impl Iterator<Item = &Item>

Returns an iterator over the AnexableArray.

Trait Implementations

impl<A, Item, const SIZE: usize> AsMut<[Item; SIZE]> for AndexableArray<A, Item, SIZE>

fn as_mut(&mut self) -> &mut [Item; SIZE]

Converts this type into a mutable reference of the (usually inferred) input type.

impl<A, Item, const SIZE: usize> AsRef<[Item; SIZE]> for AndexableArray<A, Item, SIZE>

fn as_ref(&self) -> &[Item; SIZE]

Converts this type into a shared reference of the (usually inferred) input type.

impl<A, Item: Copy, const SIZE: usize> Clone for AndexableArray<A, Item, SIZE>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<A, Item: Default + Copy, const SIZE: usize> Default for AndexableArray<A, Item, SIZE>

fn default() -> Self

Returns the “default value” for a type.

impl<A, Item, const SIZE: usize> From<&[Item; SIZE]> for AndexableArray<A, Item, SIZE>

where Item: Copy,

fn from(array: &[Item; SIZE]) -> Self

Converts to this type from the input type.

impl<A, Item, const SIZE: usize> From<&AndexableArray<A, Item, SIZE>> for [Item; SIZE]

where Item: Copy,

fn from(andexable_array: &AndexableArray<A, Item, SIZE>) -> [Item; SIZE]

Converts to this type from the input type.

impl<A, Item, const SIZE: usize> From<[Item; SIZE]> for AndexableArray<A, Item, SIZE>

fn from(array: [Item; SIZE]) -> Self

Converts to this type from the input type.

impl<A, Item, const SIZE: usize> From<AndexableArray<A, Item, SIZE>> for [Item; SIZE]

where Item: Copy,

fn from(andexable_array: AndexableArray<A, Item, SIZE>) -> [Item; SIZE]

Converts to this type from the input type.

impl<'a, A, Item: 'a + Copy, const SIZE: usize> FromIterator<&'a Item> for AndexableArray<A, Item, SIZE>

fn from_iter<I: IntoIterator<Item = &'a Item>>(intoiter: I) -> Self

Creates a value from an iterator.

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

fn from_iter<I: IntoIterator<Item = Item>>(intoiter: I) -> Self

Creates a value from an iterator.

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<'a, A, Item, const SIZE: usize> IntoIterator for &'a AndexableArray<A, Item, SIZE>

type Item = &'a Item

The type of the elements being iterated over.

type IntoIter = Iter<'a, Item>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, A, Item, const SIZE: usize> IntoIterator for &'a mut AndexableArray<A, Item, SIZE>

type Item = &'a mut Item

The type of the elements being iterated over.

type IntoIter = IterMut<'a, Item>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

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