Struct Bimap 

pub struct Bimap<K, V, S = RandomState> { /* private fields */ }

Implementations

impl<K, V> Bimap<K, V, RandomState>

where K: Eq + Hash + Clone, V: Eq + Hash + Clone,

pub fn new() -> Self

Creates an empty Bimap.

impl<K, V, S> Bimap<K, V, S>

where K: Eq + Hash + Clone, V: Eq + Hash + Clone, S: BuildHasher + Clone + Default,

pub fn with_hasher(hash_builder: S) -> Self

Creates a Bimap with the given hasher.

pub fn from_hash_map(fwd: HashMap<K, V, S>) -> Self

Creates a bimap from a HashMap.

pub fn len(&self) -> usize

Returns the number of elements in the bimap.

pub fn is_empty(&self) -> bool

Returns whether the bimap is empty.

pub fn clear(&mut self)

Removes all elements from the bimap.

pub fn insert(&mut self, k: K, v: V)

Inserts a (key, value) pair into the bimap. Panics if either the key or value is already present in the bimap; to change a key or value, call either remove_fwd or remove_rev before inserting the new (key, value) pair.

pub fn fwd(&self) -> &HashMap<K, V, S>

Gets the forward HashMap.

pub fn rev(&self) -> &HashMap<V, K, S>

Gets the reverse HashMap.

pub fn get_fwd<KeyBorrow>(&self, k: &KeyBorrow) -> Option<&V>

where K: Borrow<KeyBorrow>, KeyBorrow: Hash + Eq + ?Sized,

Gets the value corresponding to a key.

pub fn get_rev<ValBorrow>(&self, v: &ValBorrow) -> Option<&K>

where V: Borrow<ValBorrow>, ValBorrow: Hash + Eq + ?Sized,

Gets the key corresponding to a value.

pub fn remove_fwd<KeyBorrow>(&mut self, k: &KeyBorrow) -> V

where K: Borrow<KeyBorrow>, KeyBorrow: Hash + Eq + ?Sized,

Removes the (key, value) pair with the given key; returns the corresponding value.

pub fn remove_rev<ValBorrow>(&mut self, v: &ValBorrow) -> K

where V: Borrow<ValBorrow>, ValBorrow: Hash + Eq + ?Sized,

Removes the (key, value) pair with the given value; returns the corresponding key.

pub fn contains_fwd<KeyBorrow>(&self, k: &KeyBorrow) -> bool

where K: Borrow<KeyBorrow>, KeyBorrow: Hash + Eq + ?Sized,

Returns whether the bimap contains a (key, value) pair with the given key.

pub fn contains_rev<ValBorrow>(&self, v: &ValBorrow) -> bool

where V: Borrow<ValBorrow>, ValBorrow: Hash + Eq + ?Sized,

Returns whether the bimap contains a (key, value) pair with the given value.

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

Iterates over all (key, value) pairs in the bimap.

Trait Implementations

impl<K: Clone, V: Clone, S: Clone> Clone for Bimap<K, V, S>

fn clone(&self) -> Bimap<K, V, S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<K: Debug, V: Debug, S: Debug> Debug for Bimap<K, V, S>

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

Formats the value using the given formatter.

impl<K, V, S> Default for Bimap<K, V, S>

where K: Eq + Hash + Clone, V: Eq + Hash + Clone, S: BuildHasher + Clone + Default,

fn default() -> Self

Returns the “default value” for a type.

impl<K, V, S> FromIterator<(K, V)> for Bimap<K, V, S>

where K: Eq + Hash + Clone, V: Eq + Hash + Clone, S: BuildHasher + Clone + Default,

fn from_iter<T>(iter: T) -> Self

where T: IntoIterator<Item = (K, V)>,

Creates a value from an iterator.

impl<K, V, S> IntoIterator for Bimap<K, V, S>

where K: Eq + Hash + Clone, V: Eq + Hash + Clone, S: BuildHasher + Clone + Default,

type Item = (K, V)

The type of the elements being iterated over.

type IntoIter = IntoIter<K, V>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.