Struct generic_array::GenericArray

pub struct GenericArray<T, U: ArrayLength<T>> { /* fields omitted */ }

Struct representing a generic array - GenericArray<T, N> works like [T; N]

Methods

impl<T, N> GenericArray<T, N> where
    N: ArrayLength<T>, 

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

Extracts a slice containing the entire array.

pub fn as_mut_slice(&mut self) -> &mut [T]

Extracts a mutable slice containing the entire array.

pub fn from_slice(slice: &[T]) -> &GenericArray<T, N>

Converts slice to a generic array reference with inferred length;

Length of the slice must be equal to the length of the array.

pub fn from_mut_slice(slice: &mut [T]) -> &mut GenericArray<T, N>

Converts mutable slice to a mutable generic array reference

Length of the slice must be equal to the length of the array.

impl<T: Clone, N> GenericArray<T, N> where
    N: ArrayLength<T>, 

pub fn clone_from_slice(list: &[T]) -> GenericArray<T, N>

Construct a GenericArray from a slice by cloning its content

Length of the slice must be equal to the length of the array

impl<T, N> GenericArray<T, N> where
    N: ArrayLength<T>, 

pub fn from_exact_iter<I>(iter: I) -> Option<Self> where
    I: IntoIterator<Item = T>,
    <I as IntoIterator>::IntoIter: ExactSizeIterator, 

Creates a new GenericArray instance from an iterator with a known exact size.

Returns None if the size is not equal to the number of elements in the GenericArray.

Trait Implementations

impl<T, U, N> MappedGenericSequence<T, U> for GenericArray<T, N> where
    N: ArrayLength<T> + ArrayLength<U>,
    GenericArray<U, N>: GenericSequence<U, Length = N>, 

type Mapped = GenericArray<U, N>

Mapped sequence type

impl<T, N> FunctionalSequence<T> for GenericArray<T, N> where
    N: ArrayLength<T>,
    Self: GenericSequence<T, Item = T, Length = N>, 

fn map<U, F>(self, f: F) -> MappedSequence<Self, T, U> where
    Self::Length: ArrayLength<U>,
    Self: MappedGenericSequence<T, U>,
    F: FnMut(T) -> U, 

Maps a GenericSequence to another GenericSequence.

fn zip<B, Rhs, U, F>(self, rhs: Rhs, f: F) -> MappedSequence<Self, T, U> where
    Self: MappedGenericSequence<T, U>,
    Rhs: MappedGenericSequence<B, U, Mapped = MappedSequence<Self, T, U>>,
    Self::Length: ArrayLength<B> + ArrayLength<U>,
    Rhs: GenericSequence<B, Length = Self::Length>,
    F: FnMut(T, Rhs::Item) -> U, 

Combines two GenericSequence instances and iterates through both of them, initializing a new GenericSequence with the result of the zipped mapping function.

fn fold<U, F>(self, init: U, f: F) -> U where
    F: FnMut(U, T) -> U, 

Folds (or reduces) a sequence of data into a single value.

impl<T, N> GenericSequence<T> for GenericArray<T, N> where
    N: ArrayLength<T>,
    Self: IntoIterator<Item = T>, 

type Length = N

GenericArray associated length

type Sequence = Self

Concrete sequence type used in conjuction with reference implementations of GenericSequence

fn generate<F>(f: F) -> GenericArray<T, N> where
    F: FnMut(usize) -> T, 

Initializes a new sequence instance using the given function.

impl<T, N: ArrayLength<T>> Lengthen<T> for GenericArray<T, N> where
    N: Add<B1>,
    Add1<N>: ArrayLength<T>,
    Add1<N>: Sub<B1, Output = N>,
    Sub1<Add1<N>>: ArrayLength<T>, 

type Longer = GenericArray<T, Add1<N>>

GenericSequence that has one more element than Self

fn append(self, last: T) -> Self::Longer

Returns a new array with the given element appended to the end of it.

fn prepend(self, first: T) -> Self::Longer

Returns a new array with the given element prepended to the front of it.

impl<T, N: ArrayLength<T>> Shorten<T> for GenericArray<T, N> where
    N: Sub<B1>,
    Sub1<N>: ArrayLength<T>,
    Sub1<N>: Add<B1, Output = N>,
    Add1<Sub1<N>>: ArrayLength<T>, 

type Shorter = GenericArray<T, Sub1<N>>

GenericSequence that has one less element than Self

fn pop_back(self) -> (Self::Shorter, T)

Returns a new array without the last element, and the last element.

fn pop_front(self) -> (T, Self::Shorter)

Returns a new array without the first element, and the first element. Example:

impl<T, N, K> Split<T, K> for GenericArray<T, N> where
    N: ArrayLength<T>,
    K: ArrayLength<T>,
    N: Sub<K>,
    Diff<N, K>: ArrayLength<T>, 

type First = GenericArray<T, K>

First part of the resulting split array

type Second = GenericArray<T, Diff<N, K>>

Second part of the resulting split array

fn split(self) -> (Self::First, Self::Second)

Splits an array at the given index, returning the separate parts of the array.

impl<T, N, M> Concat<T, M> for GenericArray<T, N> where
    N: ArrayLength<T> + Add<M>,
    M: ArrayLength<T>,
    Sum<N, M>: ArrayLength<T>, 

type Rest = GenericArray<T, M>

Sequence to be concatenated with self

type Output = GenericArray<T, Sum<N, M>>

Resulting sequence formed by the concatenation.

fn concat(self, rest: Self::Rest) -> Self::Output

Concatenate, or join, two sequences.

impl<T: PartialEq, N> PartialEq<GenericArray<T, N>> for GenericArray<T, N> where
    N: ArrayLength<T>, 

fn eq(&self, other: &Self) -> bool

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

#[must_use]

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

This method tests for !=.

impl<T: Eq, N> Eq for GenericArray<T, N> where
    N: ArrayLength<T>, 

impl<T: Ord, N> Ord for GenericArray<T, N> where
    N: ArrayLength<T>, 

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

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

Restrict a value to a certain interval.

impl<T: PartialOrd, N> PartialOrd<GenericArray<T, N>> for GenericArray<T, N> where
    N: ArrayLength<T>, 

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

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

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

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

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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<T: Copy, N> Copy for GenericArray<T, N> where
    N: ArrayLength<T>,
    N::ArrayType: Copy, 

impl<T> From<[T; 1]> for GenericArray<T, U1>

fn from(arr: [T; 1]) -> Self

Performs the conversion.

impl<T> From<[T; 2]> for GenericArray<T, U2>

fn from(arr: [T; 2]) -> Self

Performs the conversion.

impl<T> From<[T; 3]> for GenericArray<T, U3>

fn from(arr: [T; 3]) -> Self

Performs the conversion.

impl<T> From<[T; 4]> for GenericArray<T, U4>

fn from(arr: [T; 4]) -> Self

Performs the conversion.

impl<T> From<[T; 5]> for GenericArray<T, U5>

fn from(arr: [T; 5]) -> Self

Performs the conversion.

impl<T> From<[T; 6]> for GenericArray<T, U6>

fn from(arr: [T; 6]) -> Self

Performs the conversion.

impl<T> From<[T; 7]> for GenericArray<T, U7>

fn from(arr: [T; 7]) -> Self

Performs the conversion.

impl<T> From<[T; 8]> for GenericArray<T, U8>

fn from(arr: [T; 8]) -> Self

Performs the conversion.

impl<T> From<[T; 9]> for GenericArray<T, U9>

fn from(arr: [T; 9]) -> Self

Performs the conversion.

impl<T> From<[T; 10]> for GenericArray<T, U10>

fn from(arr: [T; 10]) -> Self

Performs the conversion.

impl<T> From<[T; 11]> for GenericArray<T, U11>

fn from(arr: [T; 11]) -> Self

Performs the conversion.

impl<T> From<[T; 12]> for GenericArray<T, U12>

fn from(arr: [T; 12]) -> Self

Performs the conversion.

impl<T> From<[T; 13]> for GenericArray<T, U13>

fn from(arr: [T; 13]) -> Self

Performs the conversion.

impl<T> From<[T; 14]> for GenericArray<T, U14>

fn from(arr: [T; 14]) -> Self

Performs the conversion.

impl<T> From<[T; 15]> for GenericArray<T, U15>

fn from(arr: [T; 15]) -> Self

Performs the conversion.

impl<T> From<[T; 16]> for GenericArray<T, U16>

fn from(arr: [T; 16]) -> Self

Performs the conversion.

impl<T> From<[T; 17]> for GenericArray<T, U17>

fn from(arr: [T; 17]) -> Self

Performs the conversion.

impl<T> From<[T; 18]> for GenericArray<T, U18>

fn from(arr: [T; 18]) -> Self

Performs the conversion.

impl<T> From<[T; 19]> for GenericArray<T, U19>

fn from(arr: [T; 19]) -> Self

Performs the conversion.

impl<T> From<[T; 20]> for GenericArray<T, U20>

fn from(arr: [T; 20]) -> Self

Performs the conversion.

impl<T> From<[T; 21]> for GenericArray<T, U21>

fn from(arr: [T; 21]) -> Self

Performs the conversion.

impl<T> From<[T; 22]> for GenericArray<T, U22>

fn from(arr: [T; 22]) -> Self

Performs the conversion.

impl<T> From<[T; 23]> for GenericArray<T, U23>

fn from(arr: [T; 23]) -> Self

Performs the conversion.

impl<T> From<[T; 24]> for GenericArray<T, U24>

fn from(arr: [T; 24]) -> Self

Performs the conversion.

impl<T> From<[T; 25]> for GenericArray<T, U25>

fn from(arr: [T; 25]) -> Self

Performs the conversion.

impl<T> From<[T; 26]> for GenericArray<T, U26>

fn from(arr: [T; 26]) -> Self

Performs the conversion.

impl<T> From<[T; 27]> for GenericArray<T, U27>

fn from(arr: [T; 27]) -> Self

Performs the conversion.

impl<T> From<[T; 28]> for GenericArray<T, U28>

fn from(arr: [T; 28]) -> Self

Performs the conversion.

impl<T> From<[T; 29]> for GenericArray<T, U29>

fn from(arr: [T; 29]) -> Self

Performs the conversion.

impl<T> From<[T; 30]> for GenericArray<T, U30>

fn from(arr: [T; 30]) -> Self

Performs the conversion.

impl<T> From<[T; 31]> for GenericArray<T, U31>

fn from(arr: [T; 31]) -> Self

Performs the conversion.

impl<T> From<[T; 32]> for GenericArray<T, U32>

fn from(arr: [T; 32]) -> Self

Performs the conversion.

impl<'a, T, N: ArrayLength<T>> From<&'a [T]> for &'a GenericArray<T, N>

fn from(slice: &[T]) -> &GenericArray<T, N>

Converts slice to a generic array reference with inferred length;

Length of the slice must be equal to the length of the array.

impl<'a, T, N: ArrayLength<T>> From<&'a mut [T]> for &'a mut GenericArray<T, N>

fn from(slice: &mut [T]) -> &mut GenericArray<T, N>

Converts mutable slice to a mutable generic array reference

Length of the slice must be equal to the length of the array.

impl<T: Debug, N> Debug for GenericArray<T, N> where
    N: ArrayLength<T>, 

fn fmt(&self, fmt: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<T, N> Deref for GenericArray<T, N> where
    N: ArrayLength<T>, 

type Target = [T]

The resulting type after dereferencing.

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

Dereferences the value.

impl<T, N> DerefMut for GenericArray<T, N> where
    N: ArrayLength<T>, 

fn deref_mut(&mut self) -> &mut [T]

Mutably dereferences the value.

impl<T: Hash, N> Hash for GenericArray<T, N> where
    N: ArrayLength<T>, 

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

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<T, N> FromIterator<T> for GenericArray<T, N> where
    N: ArrayLength<T>, 

fn from_iter<I>(iter: I) -> GenericArray<T, N> where
    I: IntoIterator<Item = T>, 

Creates a value from an iterator.

impl<T: Send, N: ArrayLength<T>> Send for GenericArray<T, N>

impl<T: Sync, N: ArrayLength<T>> Sync for GenericArray<T, N>

impl<T, N> IntoIterator for GenericArray<T, N> where
    N: ArrayLength<T>, 

type Item = T

The type of the elements being iterated over.

type IntoIter = GenericArrayIter<T, N>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, T: 'a, N> IntoIterator for &'a GenericArray<T, N> where
    N: ArrayLength<T>, 

type IntoIter = Iter<'a, T>

Which kind of iterator are we turning this into?

type Item = &'a T

The type of the elements being iterated over.

fn into_iter(self: &'a GenericArray<T, N>) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, T: 'a, N> IntoIterator for &'a mut GenericArray<T, N> where
    N: ArrayLength<T>, 

type IntoIter = IterMut<'a, T>

Which kind of iterator are we turning this into?

type Item = &'a mut T

The type of the elements being iterated over.

fn into_iter(self: &'a mut GenericArray<T, N>) -> Self::IntoIter

Creates an iterator from a value.

impl<T, N> AsRef<[T]> for GenericArray<T, N> where
    N: ArrayLength<T>, 

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

Performs the conversion.

impl<T, N> AsMut<[T]> for GenericArray<T, N> where
    N: ArrayLength<T>, 

fn as_mut(&mut self) -> &mut [T]

Performs the conversion.

impl<T: ArrayLength<u8>> LowerHex for GenericArray<u8, T> where
    T: Add<T>,
    <T as Add<T>>::Output: ArrayLength<u8>, 

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

Formats the value using the given formatter.

impl<T: ArrayLength<u8>> UpperHex for GenericArray<u8, T> where
    T: Add<T>,
    <T as Add<T>>::Output: ArrayLength<u8>, 

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

Formats the value using the given formatter.

impl<T: Clone, N> Clone for GenericArray<T, N> where
    N: ArrayLength<T>, 

fn clone(&self) -> GenericArray<T, N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Default, N> Default for GenericArray<T, N> where
    N: ArrayLength<T>, 

fn default() -> Self

Returns the "default value" for a type.

impl<T, N> Borrow<[T]> for GenericArray<T, N> where
    N: ArrayLength<T>, 

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

Immutably borrows from an owned value.

impl<T, N> BorrowMut<[T]> for GenericArray<T, N> where
    N: ArrayLength<T>, 

fn borrow_mut(&mut self) -> &mut [T]

Mutably borrows from an owned value.