Struct EdgeHashMap

pub struct EdgeHashMap<'a, M: Manager, V, S> { /* private fields */ }

HashMap mapping from edges to values of type V

Internally, this map stores a Manager reference such that it can clone or drop edges accordingly. There is no need to manually drop all contained keys before dropping the map.

Implementations

impl<'a, M: Manager, V, S: Default + BuildHasher> EdgeHashMap<'a, M, V, S>

pub fn new(manager: &'a M) -> Self

Create a new edge map

pub fn with_capacity(manager: &'a M, capacity: usize) -> Self

Create a new edge map with capacity

pub fn len(&self) -> usize

Returns the number of elements in the map

pub fn is_empty(&self) -> bool

Returns true iff the map has no elements

pub fn reserve(&mut self, additional: usize)

Reserves capacity for at least additional more elements

The collection may reserve more space to speculatively avoid frequent reallocations. After calling reserve(), the capacity will be greater than or equal to self.len() + additional. Does nothing if capacity is already sufficient.

Panics

Panics if the new allocation size overflows usize.

pub fn get(&self, key: &M::Edge) -> Option<&V>

Get a reference to the value for edge (if present)

pub fn get_mut(&mut self, key: &M::Edge) -> Option<&mut V>

Get a mutable reference to the value for edge (if present)

pub fn insert(&mut self, key: &M::Edge, value: V) -> Option<V>

Insert a key-value pair into the map

If the map did not have this key present, the key is cloned, and None is returned. If the map did have this key present, the value is updated, and the old value is returned.

pub fn remove(&mut self, key: &M::Edge) -> Option<V>

Remove the entry for the given key (if present)

Returns the value that was previously stored in the map, or None, respectively.

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

Iterator visiting all key-value pairs in arbitrary order

The item type is (&M::Edge, &V).

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

Mutable iterator visiting all key-value pairs in arbitrary order

The item type is (&M::Edge, &mut V).

Trait Implementations

impl<'a, M: Manager, V: Clone, S: Default + BuildHasher> Clone for EdgeHashMap<'a, M, V, S>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, M: Manager, V, S> Drop for EdgeHashMap<'a, M, V, S>

fn drop(&mut self)

Executes the destructor for this type.

impl<'a, 'b, M: Manager, V, S> IntoIterator for &'b EdgeHashMap<'a, M, V, S>

type Item = (&'b <M as Manager>::Edge, &'b V)

The type of the elements being iterated over.

type IntoIter = Iter<'b, M, V>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, 'b, M: Manager, V, S> IntoIterator for &'b mut EdgeHashMap<'a, M, V, S>

type Item = (&'b <M as Manager>::Edge, &'b mut V)

The type of the elements being iterated over.

type IntoIter = IterMut<'b, M, V>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, M: Manager, V, S> IntoIterator for EdgeHashMap<'a, M, V, S>

type Item = (<M as Manager>::Edge, V)

The type of the elements being iterated over.

type IntoIter = IntoIter<M, V>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.