Struct HandledHashMap

pub struct HandledHashMap<T>
where
    T: Handled + Eq + PartialEq + Hash,
{ /* private fields */ }

A collection of Handled instances with automatically-generated handles, supporting efficient hash-based instance-to-handle lookup.

This data structure accumulates instances of some Handled type T, while automatically generating handles to each of the contained instances, based on their order of insertion to the vector. It supports efficient hash-based instance-to-handle lookup.

This usually serves for generating handles to instances of simple data types, not simple enough to be AutomaticallyHandled.

Example

struct Animal(String);
impl Handled for Animal {
    type HandleCoreType = u8;
}
let mut animals = HandledHashMap::new();
let dog_handle = animals.insert(Animal(String::from("dog")));
let cat_handle = animals.insert(Animal(String::from("cat")));

Implementations

impl<T> HandledHashMap<T>

where T: Handled + Eq + PartialEq + Hash,

pub fn new() -> Self

Create a new, empty, collection.

pub fn contains(&self, item: &T) -> bool

Check whether the collection contains a given item.

pub fn insert(&mut self, item: T)

Insert a new item into the collection (if it is not already there).

pub fn get_handle(&self, item: &T) -> Option<&Handle<T>>

Get the handle associated with one of the collection’s items, or None if it isn’t there.

Trait Implementations

impl<T> FromIterator<T> for HandledHashMap<T>

where T: Handled + Eq + PartialEq + Hash,

fn from_iter<U: IntoIterator<Item = T>>(iter: U) -> Self

Creates a value from an iterator.

impl<T> Index<T> for HandledHashMap<T>

where T: Handled + Eq + PartialEq + Hash,

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

Get the handle associated with one of the collection’s items.

type Output = Handle<T>

The returned type after indexing.