Struct genmap::GenMap

pub struct GenMap<T> { /* fields omitted */ }

A collection of T's referred to by Handle's. When you add an object to the GenMap it will return a Handle, and you can look that item up by that Handle. You can also remove the item, which makes any old Handle's to it become invalid and attempting to get it will return None.

Methods

impl<T> GenMap<T>

pub fn with_capacity(capacity: usize) -> Self

Create a new empty GenMap with enough memory to accomodate the given number of items without reallocating.

pub fn insert(&mut self, itm: T) -> Handle

Insert the element into the map and return a handle referring to it.

pub fn get(&self, h: Handle) -> Option<&T>

Returns a reference to the item if the handle is valid, or None otherwise.

pub fn get_mut(&mut self, h: Handle) -> Option<&mut T>

Returns a mutable reference to the item if the handle is valid, or None otherwise.

pub fn remove(&mut self, h: Handle) -> Option<T>

Removes the referenced item from the map, returning it. Returns None if the handle is stale.

pub fn count(&self) -> usize

Number of items in the map.

pub fn capacity(&self) -> usize

The total number of items the map has free memory to contain.

Important traits for Iterator<'_, T>

impl<'_, T> Iterator for Iterator<'_, T> type Item = Handle;

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

Trait Implementations

impl<T: Default> Default for GenMap<T>

fn default() -> GenMap<T>

Returns the "default value" for a type.

impl<T: Clone> Clone for GenMap<T>

fn clone(&self) -> GenMap<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for GenMap<T>

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

Formats the value using the given formatter.