Struct ArrayWrapperRef 

#[repr(transparent)]
pub struct ArrayWrapperRef<'array, T, const N: usize>(pub &'array [T; N]);

Immutable array reference wrapper similar to crate::ArrayWrapper.

Tuple Fields

0: &'array [T; N]

The actual array reference.

Methods from Deref<Target = [T; N]>

pub fn as_slice(&self) -> &[T]

Returns a slice containing the entire array. Equivalent to &s[..].

pub fn each_ref(&self) -> [&T; N]

Borrows each element and returns an array of references with the same size as self.

Example

let floats = [3.1, 2.7, -1.0];
let float_refs: [&f64; 3] = floats.each_ref();
assert_eq!(float_refs, [&3.1, &2.7, &-1.0]);

This method is particularly useful if combined with other methods, like map. This way, you can avoid moving the original array if its elements are not Copy.

let strings = ["Ferris".to_string(), "♥".to_string(), "Rust".to_string()];
let is_ascii = strings.each_ref().map(|s| s.is_ascii());
assert_eq!(is_ascii, [true, false, true]);

// We can still access the original array: it has not been moved.
assert_eq!(strings.len(), 3);

pub fn split_array_ref<const M: usize>(&self) -> (&[T; M], &[T])

🔬This is a nightly-only experimental API. (split_array)

Divides one array reference into two at an index.

The first will contain all indices from [0, M) (excluding the index M itself) and the second will contain all indices from [M, N) (excluding the index N itself).

Panics

Panics if M > N.

Examples

#![feature(split_array)]

let v = [1, 2, 3, 4, 5, 6];

{
   let (left, right) = v.split_array_ref::<0>();
   assert_eq!(left, &[]);
   assert_eq!(right, &[1, 2, 3, 4, 5, 6]);
}

{
    let (left, right) = v.split_array_ref::<2>();
    assert_eq!(left, &[1, 2]);
    assert_eq!(right, &[3, 4, 5, 6]);
}

{
    let (left, right) = v.split_array_ref::<6>();
    assert_eq!(left, &[1, 2, 3, 4, 5, 6]);
    assert_eq!(right, &[]);
}

pub fn rsplit_array_ref<const M: usize>(&self) -> (&[T], &[T; M])

🔬This is a nightly-only experimental API. (split_array)

Divides one array reference into two at an index from the end.

The first will contain all indices from [0, N - M) (excluding the index N - M itself) and the second will contain all indices from [N - M, N) (excluding the index N itself).

Panics

Panics if M > N.

Examples

#![feature(split_array)]

let v = [1, 2, 3, 4, 5, 6];

{
   let (left, right) = v.rsplit_array_ref::<0>();
   assert_eq!(left, &[1, 2, 3, 4, 5, 6]);
   assert_eq!(right, &[]);
}

{
    let (left, right) = v.rsplit_array_ref::<2>();
    assert_eq!(left, &[1, 2, 3, 4]);
    assert_eq!(right, &[5, 6]);
}

{
    let (left, right) = v.rsplit_array_ref::<6>();
    assert_eq!(left, &[]);
    assert_eq!(right, &[1, 2, 3, 4, 5, 6]);
}

Trait Implementations

impl<T, const N: usize> AsRef<[T; N]> for ArrayWrapperRef<'_, T, N>

fn as_ref(&self) -> &[T; N]

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

impl<T, const N: usize> Borrow<[T; N]> for ArrayWrapperRef<'_, T, N>

fn borrow(&self) -> &[T; N]

Immutably borrows from an owned value.

impl<'array, T: Clone, const N: usize> Clone for ArrayWrapperRef<'array, T, N>

fn clone(&self) -> ArrayWrapperRef<'array, T, N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'array, T: Debug, const N: usize> Debug for ArrayWrapperRef<'array, T, N>

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

Formats the value using the given formatter.

impl<T, const N: usize> Deref for ArrayWrapperRef<'_, T, N>

type Target = [T; N]

The resulting type after dereferencing.

fn deref(&self) -> &[T; N]

Dereferences the value.

impl<'array, T, const N: usize> From<&'array [T; N]> for ArrayWrapperRef<'array, T, N>

fn from(from: &'array [T; N]) -> Self

Converts to this type from the input type.

impl<'array, T, const N: usize> IntoIterator for &'array ArrayWrapperRef<'array, T, N>

type IntoIter = Iter<'array, T>

Which kind of iterator are we turning this into?

type Item = &'array T

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'array, T: Ord, const N: usize> Ord for ArrayWrapperRef<'array, T, N>

fn cmp(&self, other: &ArrayWrapperRef<'array, T, N>) -> 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,

Restrict a value to a certain interval.

impl<'array, T: PartialEq, const N: usize> PartialEq for ArrayWrapperRef<'array, T, N>

fn eq(&self, other: &ArrayWrapperRef<'array, T, N>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'array, T: PartialOrd, const N: usize> PartialOrd for ArrayWrapperRef<'array, T, N>

fn partial_cmp(&self, other: &ArrayWrapperRef<'array, T, N>) -> Option<Ordering>

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'array, T: Copy, const N: usize> Copy for ArrayWrapperRef<'array, T, N>

impl<'array, T: Eq, const N: usize> Eq for ArrayWrapperRef<'array, T, N>

impl<'array, T, const N: usize> StructuralPartialEq for ArrayWrapperRef<'array, T, N>