Struct bidirectional_map::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 get_fwd<KeyBorrow: ?Sized>(&self, k: &KeyBorrow) -> Option<&V>where
    K: Borrow<KeyBorrow>,
    KeyBorrow: Hash + Eq,

Gets the value corresponding to a key.

pub fn get_rev<ValBorrow: ?Sized>(&self, v: &ValBorrow) -> Option<&K>where
    V: Borrow<ValBorrow>,
    ValBorrow: Hash + Eq,

Gets the key corresponding to a value.

pub fn remove_fwd<KeyBorrow: ?Sized>(&mut self, k: &KeyBorrow) -> Vwhere
    K: Borrow<KeyBorrow>,
    KeyBorrow: Hash + Eq,

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

pub fn remove_rev<ValBorrow: ?Sized>(&mut self, v: &ValBorrow) -> Kwhere
    V: Borrow<ValBorrow>,
    ValBorrow: Hash + Eq,

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

pub fn contains_fwd<KeyBorrow: ?Sized>(&self, k: &KeyBorrow) -> boolwhere
    K: Borrow<KeyBorrow>,
    KeyBorrow: Hash + Eq,

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

pub fn contains_rev<ValBorrow: ?Sized>(&self, v: &ValBorrow) -> boolwhere
    V: Borrow<ValBorrow>,
    ValBorrow: Hash + Eq,

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 copy of the value.

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

Performs copy-assignment from source.

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.