Struct fera_array::NestedArray

pub struct NestedArray<T, S, M, N> { /* private fields */ }

An Array implemented as an array of arrays.

It contains a main Array of type M. Each element (nested array) of the main array is an Array of type N. The type of the elements of the nested arrays is T.

This type offers a flatted view of the elements in the nested arrays. Each time an element at a specified index is accessed, the index is decomposed in two indices (using S: Split), the first one is used to index the main array and the second one to index the nested array.

This type is interesting to implemented copy on write arrays. See CowNestedArray.

Trait Implementations

impl<T, S, M, N> Array<T> for NestedArray<T, S, M, N>where
    S: Split,
    M: Array<N>,
    N: Array<T> + Clone,

fn with_value(value: T, n: usize) -> Selfwhere
    T: Clone,

Creates a new array with n repeated value.

fn len(&self) -> usize

Returns the number of elements in the array.

unsafe fn get_unchecked(&self, index: usize) -> &T

Returns a reference to the element of the array at index, without doing bounds checking.

unsafe fn get_unchecked_mut(&mut self, index: usize) -> &mut T

Returns a mutable reference to the element of the array at index, without doing bounds checking.

fn is_empty(&self) -> bool

Returns true if the length of the array is 0, otherwise false.

fn get(&self, index: usize) -> Option<&T>

Returns a reference to the element of the array at index, or None if the index is out of bounds.

fn get_mut(&mut self, index: usize) -> Option<&mut T>

Returns a mutable reference to the element of the array at index, or None if the index is out of bounds.

fn iter(&self) -> Iter<'_, T, Self> where
    Self: Sized,

Returns a iterator over the array.

impl<T: Clone, S: Clone, M: Clone, N: Clone> Clone for NestedArray<T, S, M, N>

fn clone(&self) -> NestedArray<T, S, M, N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, S, M, N> DynamicArray<T> for NestedArray<T, S, M, N>where
    S: Split,
    M: DynamicArray<N>,
    N: DynamicArray<T> + Clone,

fn with_capacity(capacity: usize) -> Selfwhere
    Self: Sized,

Creates a array with the specified capacity.

fn capacity(&self) -> usize

Returns the capacity of the array.

unsafe fn set_len(&mut self, len: usize)

Change the length of the array.

fn reserve(&mut self, additional: usize)

Reserve capacity for at least additional more elements.

unsafe fn push_unchecked(&mut self, value: T)

Write value to the end of the array and increment the length.

fn push(&mut self, value: T)

Appends the value to the array.

fn extend<I>(&mut self, iter: I)where
    Self: Sized,
    I: IntoIterator<Item = T>,

Appends all elements of iter to the array.

impl<T, S, M, N> Index<usize> for NestedArray<T, S, M, N>where
    S: Split,
    M: Array<N>,
    N: Array<T> + Clone,

type Output = T

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T, S, M, N> IndexMut<usize> for NestedArray<T, S, M, N>where
    S: Split,
    M: Array<N>,
    N: Array<T> + Clone,

fn index_mut(&mut self, index: usize) -> &mut Self::Output

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