Trait array_math::Array

pub trait Array: Array + ArrayPrereq {
    const LENGTH: usize;

    // Required methods
    fn into_array<const N: usize>(self) -> [Self::Item; N]
       where Self: Array<LENGTH = N>;
    fn as_array<const N: usize>(&self) -> &[Self::Item; N]
       where Self: Array<LENGTH = N>;
    fn as_array_mut<const N: usize>(&mut self) -> &mut [Self::Item; N]
       where Self: Array<LENGTH = N>;
}

Required Associated Constants

const LENGTH: usize

Length of array as compile-time constant

Example 1: Length

Array::LENGTH will always equal the actual length of the array.

use array_trait::Array;
 
const L: usize = 4;
 
let array: [f32; L] = [1.0, 2.0, 3.0, 4.0];
 
assert_eq!(<[f32; L]>::LENGTH, L);
assert_eq!(<[f32; L]>::LENGTH, array.len());

Example 2: Generic const-expression usage

This can be used in const-expressions as shown below.

#![feature(generic_const_exprs)]
#![feature(iter_array_chunks)]
 
use array_trait::Array;
 
fn first_half<T: Array>(array: T) -> [T::Item; T::LENGTH/2]
{
    array.into_iter().array_chunks().next().unwrap()
}
 
assert_eq!(first_half([1.0, 2.0, 3.0, 4.0]), [1.0, 2.0]);

Required Methods

fn into_array<const N: usize>(self) -> [Self::Item; N]

where Self: Array<LENGTH = N>,

Returns self as an array

Useful in the case where a trait is implemented using a generic bound to the Array trait. In this case, the compiler does not automatically know that the type with the Array-trait is an actual array. This method lets you tell the compiler that you are now working with an actual array, and not just something which implements the trait Array.

fn as_array<const N: usize>(&self) -> &[Self::Item; N]

where Self: Array<LENGTH = N>,

Returns self as an array-slice

Similar to Array::into_array, but is passed by reference.

Useful in the case where a trait is implemented using a generic bound to the Array trait. In this case, the compiler does not automatically know that the type with the Array-trait is an actual array. This method lets you tell the compiler that you are now working with an actual array, and not just something which implements the trait Array.

fn as_array_mut<const N: usize>(&mut self) -> &mut [Self::Item; N]

where Self: Array<LENGTH = N>,

Returns self as a mutable array-slice

Similar to Array::into_array, but is passed by mutable reference.

Useful in the case where a trait is implemented using a generic bound to the Array trait. In this case, the compiler does not automatically know that the type with the Array-trait is an actual array. This method lets you tell the compiler that you are now working with an actual array, and not just something which implements the trait Array.

Object Safety

This trait is not object safe.

Implementations on Foreign Types

impl<Item, const LENGTH: usize> Array for [Item; LENGTH]

const LENGTH: usize = LENGTH

fn into_array<const N: usize>( self ) -> [<[Item; LENGTH] as IntoIterator>::Item; N]

where [Item; LENGTH]: Array<LENGTH = N>,

fn as_array<const N: usize>( &self ) -> &[<[Item; LENGTH] as IntoIterator>::Item; N]

where [Item; LENGTH]: Array<LENGTH = N>,

fn as_array_mut<const N: usize>( &mut self ) -> &mut [<[Item; LENGTH] as IntoIterator>::Item; N]

where [Item; LENGTH]: Array<LENGTH = N>,

Implementors