Struct tiny_ecs::MapRefMut

pub struct MapRefMut<'a, T> { /* fields omitted */ }

Mutable reference container for Persist returned by Entities::borrow_mut()

This struct is required to contain a hidden borrow to the requested Persist. The reason for this is so we can borrow multiple Persist, but not break the borrow checker rules for borrows on a single Persist.

Methods from Deref<Target = Persist<T>>

pub fn len(&self) -> usize

Returns the actual used length regardless of capacity

pub fn is_empty(&self) -> bool

pub fn capacity(&self) -> usize

Returns the storage capacity

pub fn clear(&mut self)

Clear the storage out while keeping allocated memory

Should not ever panic

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

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

pub fn is_index_live(&self, index: usize) -> bool

Check if there is a value at this index

pub fn push(&mut self, value: T) -> Option<usize>

Push T on to storage.

A push is not guaranteed to push in any particular order if the internal storage has empty locations (typical after many remove). For this reason it will return the index pushed to.

Returns None if there are no free slots left

pub fn insert(&mut self, index: usize, value: T) -> Option<T>

Insert T at location. Returns existing value in that location or None.

Panics

Will panic is the index is out of range

pub fn pop(&mut self) -> Option<T>

Pop the last value in the Persist

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

Remove the item at this index and return it if it exists. Does not shift elements after it to the left.

pub fn iter(&self) -> Iter<T>

pub fn iter_mut(&mut self) -> IterMut<T>

Trait Implementations

impl<'a, T> Deref for MapRefMut<'a, T>

type Target = Persist<T>

The resulting type after dereferencing.

fn deref(&self) -> &Persist<T>

Dereferences the value.

impl<'a, T> DerefMut for MapRefMut<'a, T>

fn deref_mut(&mut self) -> &mut Persist<T>

Mutably dereferences the value.