Trait kwap_common::Array

pub trait Array: Default + GetSize + Reserve + Deref<Target = [Self::Item]> + DerefMut + Extend<Self::Item> + FromIterator<Self::Item> + IntoIterator<Item = Self::Item> {
    type Item;

    fn insert_at(&mut self, index: usize, value: <Self as Array>::Item);
    fn remove(&mut self, index: usize) -> Option<<Self as Array>::Item>;
    fn push(&mut self, value: <Self as Array>::Item);
}

An ordered indexable collection of some type Item

Provided implementations

• Vec
• tinyvec::ArrayVec

Notably, not heapless::ArrayVec or arrayvec::ArrayVec. An important usecase within kwap is Extending the collection, and the performance of heapless and arrayvec’s Extend implementations are notably worse than tinyvec.

tinyvec also has the added bonus of being 100% unsafe-code-free, meaning if you choose tinyvec you eliminate the possibility of memory defects and UB.

Requirements

• Default for creating the collection
• Extend for mutating and adding onto the collection (1 or more elements)
• Reserve for reserving space ahead of time
• [Insert] for pushing and inserting elements into the collection
• GetSize for bound checks, empty checks, and accessing the length
• FromIterator for collecting into the collection
• IntoIterator for iterating and destroying the collection
• Deref<Target = [T]> and DerefMut for:
  • indexing (Index, IndexMut)
  • iterating (&[T].iter() and &mut [T].iter_mut())

Required Associated Types

type Item

The type of item contained in the collection

Required Methods

fn insert_at(&mut self, index: usize, value: <Self as Array>::Item)

Insert a value at a particular index of a collection.

fn remove(&mut self, index: usize) -> Option<<Self as Array>::Item>

Try to remove an entry from the collection.

Returns Some(Self::Item) if index was in-bounds, None if index is out of bounds.

fn push(&mut self, value: <Self as Array>::Item)

Add a value to the end of a collection.

Implementations on Foreign Types

impl<T> Array for Vec<T>

type Item = T

fn insert_at(&mut self, index: usize, value: T)

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

fn push(&mut self, value: T)

impl<A: Array<Item = T>, T> Array for ArrayVec<A>

type Item = T

fn insert_at(&mut self, index: usize, value: A::Item)

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

fn push(&mut self, value: A::Item)

Implementors