Struct MappingDict

pub struct MappingDict<V: Mappable> { /* private fields */ }

A map comparable to a HashMap which contains items that are Mappable. The map keeps track of the mapping between both the external type and Matrix type and an object.

Implementations

impl<V> MappingDict<V>

where V: Mappable,

pub fn new() -> Self

Create a new empty MappingDict.

pub fn from_vec(items: Vec<V>) -> Self

Create a new MappingDict consuming the given Vec of items. All items are put into the newly created map.

This is more efficient than just calling insert yourself on an empty map, since this method will initialize the vector and hashmap with a starting capacpity, thus resulting in less allocations.

pub fn insert(&mut self, item: V) -> &mut V

Inserts the given item in the current MappingDict. Allocates if neccesary.

Returns a mutable reference to the newly inserted item.

pub fn get( &self, identifier: MappingId<'_, V::ExternalReference, V::MatrixReference>, ) -> Option<&V>

Returns a reference to the item associated with the given identifier, or None if no such item exists.

pub fn get_mut( &mut self, identifier: MappingId<'_, V::ExternalReference, V::MatrixReference>, ) -> Option<&mut V>

Returns a mutable reference to the item associated with the given identifier, or None if no such item exists.

pub fn has( &self, identifier: MappingId<'_, V::ExternalReference, V::MatrixReference>, ) -> bool

Returns whether or not this MappingDict contains an item associated with the given identifier.

pub fn remove( &mut self, identifier: MappingId<'_, V::ExternalReference, V::MatrixReference>, ) -> Option<V>

If this MappingDict contains an item associated with the given identifier, remove it and return the value that was contained in the MappingDict. If no such item exists, this function returns None.

pub fn iter(&self) -> Iter<'_, V>

Get an iterator over references of the items contained in this MappingDict.

pub fn iter_mut(&mut self) -> IterMut<'_, V>

Get an iterator over mutable references of the items contained in this MappingDict.

pub fn shrink_to_fit(&mut self)

Shrinks the capacity of the map as much as possible. It will drop down as much as possible while maintaining the internal rules and possibly leaving some space in accordance with the resize policy.

Trait Implementations

impl<V: Clone + Mappable> Clone for MappingDict<V>

where V::ExternalType: Clone, V::MatrixType: Clone,

fn clone(&self) -> MappingDict<V>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<V: Debug + Mappable> Debug for MappingDict<V>

where V::ExternalType: Debug, V::MatrixType: Debug,

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

Formats the value using the given formatter.

impl<T: Mappable> Default for MappingDict<T>

fn default() -> Self

Returns the “default value” for a type.

impl<'a, T> IntoIterator for &'a MappingDict<T>

where T: Mappable,

type Item = &'a T

The type of the elements being iterated over.

type IntoIter = Iter<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<V> IntoIterator for MappingDict<V>

where V: Mappable,

type Item = V

The type of the elements being iterated over.

type IntoIter = IntoIter<<MappingDict<V> as IntoIterator>::Item>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.