Struct SliceMap 

pub struct SliceMap<K, V, S>
where
    K: Key,
    S: SliceStorage<K, Range<u32>>,
{ /* private fields */ }

This generic SliceMap needs to be provided a Key type, a Value type and a Storage type. Use SlotSliceMap and SecSliceMap for storage using SlotMap and SecondarySlotMap, respectively.

Implementations

impl<K, V, S> SliceMap<K, V, S>

where K: Key, S: SliceStorage<K, Range<u32>> + Default,

pub fn new() -> Self

Returns a new SliceMap containing the provided items object.

pub fn with_capacity(cap: usize) -> Self

Returns a new SliceMap with the specified initial capacity.

pub fn clear(&mut self)

Clears the SliceMap.

pub fn items(&self) -> &[V]

Returns a slice with all items in all slices.

pub fn items_len(&self) -> usize

How many items are contained in all slices.

pub fn is_empty(&self) -> bool

True if no items

pub fn slices_len(&self) -> usize

How many slices are contained in the SliceMap.

pub fn get_slice(&self, key: K) -> Option<&[V]>

Returns a slice with the desired range

pub fn iter_slices(&self) -> SliceIter<'_, K, V, S>

Returns an iterator for slices of items.

pub fn iter_keys_and_slices(&self) -> KeySliceIter<'_, K, V, S>

Returns an iterator for slices of items along with their keys.

pub fn iter_items(&self) -> impl Iterator<Item = &V>

Returns an iterator for each individual item.

pub fn remove_slice(&mut self, key: K) -> Option<Range<u32>>

Removes a slice by key. Warning: Will cause all items to “shift” to occupy the removed space, and all slices will be updated with the new indices.

impl<K, V> SliceMap<K, V, SlotMap<K, Range<u32>>>

where K: Key, V: Clone,

pub fn add_items<ITEMS>(&mut self, new_items: ITEMS) -> K

where ITEMS: AsRef<[V]>,

Creates a new slice with all items from an iterator of owned or borrowed V items. Accepts arrays, slices, or any type that implements AsRef<[V]>. Will panic if the capacity of u32::MAX items is reached.

impl<K, V> SliceMap<K, V, SecondaryMap<K, Range<u32>>>

where K: Key, V: Clone,

pub fn add_items<ITEMS>(&mut self, key: K, new_items: ITEMS)

where ITEMS: AsRef<[V]>,

Creates a new slice with all items from an iterable of owned or borrowed V items. Accepts arrays, slices, or any other AsRef<[V]> type. Will panic if the capacity of u32::MAX items is reached.

impl<K, V> SliceMap<K, V, SparseSecondaryMap<K, Range<u32>>>

where K: Key, V: Clone,

pub fn add_items<ITEMS>(&mut self, key: K, new_items: ITEMS)

where ITEMS: AsRef<[V]>,

Creates a new slice with all items from an iterable of owned or borrowed V items. Accepts arrays, slices, or any other AsRef<[V]> type. Will panic if the capacity of u32::MAX items is reached.

Trait Implementations

impl<K, V: Clone, S> Clone for SliceMap<K, V, S>

where K: Key + Clone, S: SliceStorage<K, Range<u32>> + Clone,

fn clone(&self) -> SliceMap<K, V, S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<K, V: Debug, S> Debug for SliceMap<K, V, S>

where K: Key + Debug, S: SliceStorage<K, Range<u32>> + Debug,

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

Formats the value using the given formatter.

impl<K, V: Default, S> Default for SliceMap<K, V, S>

where K: Key + Default, S: SliceStorage<K, Range<u32>> + Default,

fn default() -> SliceMap<K, V, S>

Returns the “default value” for a type.