[−][src]Struct multimap::MultiMap
Methods
impl<K, V> MultiMap<K, V> where
K: Eq + Hash,
[src]
K: Eq + Hash,
pub fn new() -> MultiMap<K, V>
[src]
Creates an empty MultiMap
Examples
use multimap::MultiMap; let mut map: MultiMap<&str, isize> = MultiMap::new();
pub fn with_capacity(capacity: usize) -> MultiMap<K, V>
[src]
Creates an empty multimap with the given initial capacity.
Examples
use multimap::MultiMap; let mut map: MultiMap<&str, isize> = MultiMap::with_capacity(20);
impl<K, V, S> MultiMap<K, V, S> where
K: Eq + Hash,
S: BuildHasher,
[src]
K: Eq + Hash,
S: BuildHasher,
pub fn with_hasher(hash_builder: S) -> MultiMap<K, V, S>
[src]
Creates an empty MultiMap which will use the given hash builder to hash keys.
Examples
use multimap::MultiMap; use std::collections::hash_map::RandomState; let s = RandomState::new(); let mut map: MultiMap<&str, isize> = MultiMap::with_hasher(s);
pub fn with_capacity_and_hasher(
capacity: usize,
hash_builder: S
) -> MultiMap<K, V, S>
[src]
capacity: usize,
hash_builder: S
) -> MultiMap<K, V, S>
Creates an empty MultiMap with the given intial capacity and hash builder.
Examples
use multimap::MultiMap; use std::collections::hash_map::RandomState; let s = RandomState::new(); let mut map: MultiMap<&str, isize> = MultiMap::with_capacity_and_hasher(20, s);
pub fn insert(&mut self, k: K, v: V)
[src]
Inserts a key-value pair into the multimap. If the key does exist in the map then the value is pushed to that key's vector. If the key doesn't exist in the map a new vector with the given value is inserted.
Examples
use multimap::MultiMap; let mut map = MultiMap::new(); map.insert("key", 42);
pub fn insert_many<I: IntoIterator<Item = V>>(&mut self, k: K, v: I)
[src]
Inserts multiple key-value pairs into the multimap. If the key does exist in the map then the values are extended into that key's vector. If the key doesn't exist in the map a new vector collected from the given values is inserted.
This may be more efficient than inserting values independently.
Examples
use multimap::MultiMap; let mut map = MultiMap::<&str, &usize>::new(); map.insert_many("key", &[42, 43]);
pub fn insert_many_from_slice(&mut self, k: K, v: &[V]) where
V: Clone,
[src]
V: Clone,
Inserts multiple key-value pairs into the multimap. If the key does exist in the map then the values are extended into that key's vector. If the key doesn't exist in the map a new vector collected from the given values is inserted.
This may be more efficient than inserting values independently.
Examples
use multimap::MultiMap; let mut map = MultiMap::<&str, usize>::new(); map.insert_many_from_slice("key", &[42, 43]);
pub fn contains_key<Q: ?Sized>(&self, k: &Q) -> bool where
K: Borrow<Q>,
Q: Eq + Hash,
[src]
K: Borrow<Q>,
Q: Eq + Hash,
Returns true if the map contains a value for the specified key.
The key may be any borrowed form of the map's key type, but Hash and Eq on the borrowed form must match those for the key type.
Examples
use multimap::MultiMap; let mut map = MultiMap::new(); map.insert(1, 42); assert_eq!(map.contains_key(&1), true); assert_eq!(map.contains_key(&2), false);
pub fn len(&self) -> usize
[src]
Returns the number of elements in the map.
Examples
use multimap::MultiMap; let mut map = MultiMap::new(); map.insert(1, 42); map.insert(2, 1337); assert_eq!(map.len(), 2);
pub fn remove<Q: ?Sized>(&mut self, k: &Q) -> Option<Vec<V>> where
K: Borrow<Q>,
Q: Eq + Hash,
[src]
K: Borrow<Q>,
Q: Eq + Hash,
Removes a key from the map, returning the vector of values at the key if the key was previously in the map.
The key may be any borrowed form of the map's key type, but Hash and Eq on the borrowed form must match those for the key type.
Examples
use multimap::MultiMap; let mut map = MultiMap::new(); map.insert(1, 42); map.insert(1, 1337); assert_eq!(map.remove(&1), Some(vec![42, 1337])); assert_eq!(map.remove(&1), None);
pub fn get<Q: ?Sized>(&self, k: &Q) -> Option<&V> where
K: Borrow<Q>,
Q: Eq + Hash,
[src]
K: Borrow<Q>,
Q: Eq + Hash,
Returns a reference to the first item in the vector corresponding to the key.
The key may be any borrowed form of the map's key type, but Hash and Eq on the borrowed form must match those for the key type.
Examples
use multimap::MultiMap; let mut map = MultiMap::new(); map.insert(1, 42); map.insert(1, 1337); assert_eq!(map.get(&1), Some(&42));
pub fn get_mut<Q: ?Sized>(&mut self, k: &Q) -> Option<&mut V> where
K: Borrow<Q>,
Q: Eq + Hash,
[src]
K: Borrow<Q>,
Q: Eq + Hash,
Returns a mutable reference to the first item in the vector corresponding to the key.
The key may be any borrowed form of the map's key type, but Hash and Eq on the borrowed form must match those for the key type.
Examples
use multimap::MultiMap; let mut map = MultiMap::new(); map.insert(1, 42); map.insert(1, 1337); if let Some(v) = map.get_mut(&1) { *v = 99; } assert_eq!(map[&1], 99);
pub fn get_vec<Q: ?Sized>(&self, k: &Q) -> Option<&Vec<V>> where
K: Borrow<Q>,
Q: Eq + Hash,
[src]
K: Borrow<Q>,
Q: Eq + Hash,
Returns a reference to the vector corresponding to the key.
The key may be any borrowed form of the map's key type, but Hash and Eq on the borrowed form must match those for the key type.
Examples
use multimap::MultiMap; let mut map = MultiMap::new(); map.insert(1, 42); map.insert(1, 1337); assert_eq!(map.get_vec(&1), Some(&vec![42, 1337]));
pub fn get_vec_mut<Q: ?Sized>(&mut self, k: &Q) -> Option<&mut Vec<V>> where
K: Borrow<Q>,
Q: Eq + Hash,
[src]
K: Borrow<Q>,
Q: Eq + Hash,
Returns a mutable reference to the vector corresponding to the key.
The key may be any borrowed form of the map's key type, but Hash and Eq on the borrowed form must match those for the key type.
Examples
use multimap::MultiMap; let mut map = MultiMap::new(); map.insert(1, 42); map.insert(1, 1337); if let Some(v) = map.get_vec_mut(&1) { (*v)[0] = 1991; (*v)[1] = 2332; } assert_eq!(map.get_vec(&1), Some(&vec![1991, 2332]));
pub fn is_vec<Q: ?Sized>(&self, k: &Q) -> bool where
K: Borrow<Q>,
Q: Eq + Hash,
[src]
K: Borrow<Q>,
Q: Eq + Hash,
Returns true if the key is multi-valued.
The key may be any borrowed form of the map's key type, but Hash and Eq on the borrowed form must match those for the key type.
Examples
use multimap::MultiMap; let mut map = MultiMap::new(); map.insert(1, 42); map.insert(1, 1337); map.insert(2, 2332); assert_eq!(map.is_vec(&1), true); // key is multi-valued assert_eq!(map.is_vec(&2), false); // key is single-valued assert_eq!(map.is_vec(&3), false); // key not in map
pub fn capacity(&self) -> usize
[src]
Returns the number of elements the map can hold without reallocating.
Examples
use multimap::MultiMap; let map: MultiMap<usize, usize> = MultiMap::new(); assert!(map.capacity() >= 0);
pub fn is_empty(&self) -> bool
[src]
Returns true if the map contains no elements.
Examples
use multimap::MultiMap; let mut map = MultiMap::new(); assert!(map.is_empty()); map.insert(1,42); assert!(!map.is_empty());
pub fn clear(&mut self)
[src]
Clears the map, removing all key-value pairs. Keeps the allocated memory for reuse.
Examples
use multimap::MultiMap; let mut map = MultiMap::new(); map.insert(1,42); map.clear(); assert!(map.is_empty());
pub fn keys<'a>(&'a self) -> Keys<'a, K, Vec<V>>
[src]
An iterator visiting all keys in arbitrary order. Iterator element type is &'a K.
Examples
use multimap::MultiMap; let mut map = MultiMap::new(); map.insert(1,42); map.insert(2,1337); map.insert(4,1991); for key in map.keys() { println!("{:?}", key); }
pub fn iter(&self) -> Iter<K, V>
[src]
An iterator visiting all key-value pairs in arbitrary order. The iterator returns a reference to the key and the first element in the corresponding key's vector. Iterator element type is (&'a K, &'a V).
Examples
use multimap::MultiMap; let mut map = MultiMap::new(); map.insert(1,42); map.insert(1,1337); map.insert(3,2332); map.insert(4,1991); for (key, value) in map.iter() { println!("key: {:?}, val: {:?}", key, value); }
pub fn iter_mut(&mut self) -> IterMut<K, V>
[src]
An iterator visiting all key-value pairs in arbitrary order. The iterator returns a reference to the key and a mutable reference to the first element in the corresponding key's vector. Iterator element type is (&'a K, &'a mut V).
Examples
use multimap::MultiMap; let mut map = MultiMap::new(); map.insert(1,42); map.insert(1,1337); map.insert(3,2332); map.insert(4,1991); for (_, value) in map.iter_mut() { *value *= *value; } for (key, value) in map.iter() { println!("key: {:?}, val: {:?}", key, value); }
pub fn iter_all(&self) -> IterAll<K, Vec<V>>
[src]
An iterator visiting all key-value pairs in arbitrary order. The iterator returns a reference to the key and the corresponding key's vector. Iterator element type is (&'a K, &'a V).
Examples
use multimap::MultiMap; let mut map = MultiMap::new(); map.insert(1,42); map.insert(1,1337); map.insert(3,2332); map.insert(4,1991); for (key, values) in map.iter_all() { println!("key: {:?}, values: {:?}", key, values); }
pub fn iter_all_mut(&mut self) -> IterAllMut<K, Vec<V>>
[src]
An iterator visiting all key-value pairs in arbitrary order. The iterator returns a reference to the key and the corresponding key's vector. Iterator element type is (&'a K, &'a V).
Examples
use multimap::MultiMap; let mut map = MultiMap::new(); map.insert(1,42); map.insert(1,1337); map.insert(3,2332); map.insert(4,1991); for (key, values) in map.iter_all_mut() { for value in values.iter_mut() { *value = 99; } } for (key, values) in map.iter_all() { println!("key: {:?}, values: {:?}", key, values); }
pub fn entry(&mut self, k: K) -> Entry<K, V>
[src]
Gets the specified key's corresponding entry in the map for in-place manipulation. It's possible to both manipulate the vector and the 'value' (the first value in the vector).
Examples
use multimap::MultiMap; let mut m = MultiMap::new(); m.insert(1, 42); { let mut v = m.entry(1).or_insert(43); assert_eq!(v, &42); *v = 44; } assert_eq!(m.entry(2).or_insert(666), &666); { let mut v = m.entry(1).or_insert_vec(vec![43]); assert_eq!(v, &vec![44]); v.push(50); } assert_eq!(m.entry(2).or_insert_vec(vec![666]), &vec![666]); assert_eq!(m.get_vec(&1), Some(&vec![44, 50]));
pub fn retain<F>(&mut self, f: F) where
F: FnMut(&K, &V) -> bool,
[src]
F: FnMut(&K, &V) -> bool,
Retains only the elements specified by the predicate.
In other words, remove all pairs (k, v)
such that f(&k,&mut v)
returns false
.
Examples
use multimap::MultiMap; let mut m = MultiMap::new(); m.insert(1, 42); m.insert(1, 99); m.insert(2, 42); m.retain(|&k, &v| { k == 1 && v == 42 }); assert_eq!(1, m.len()); assert_eq!(Some(&42), m.get(&1));
Trait Implementations
impl<K: Clone, V: Clone, S: Clone> Clone for MultiMap<K, V, S>
[src]
impl<K, V, S> Debug for MultiMap<K, V, S> where
K: Eq + Hash + Debug,
V: Debug,
S: BuildHasher,
[src]
K: Eq + Hash + Debug,
V: Debug,
S: BuildHasher,
impl<K, V, S> Default for MultiMap<K, V, S> where
K: Eq + Hash,
S: BuildHasher + Default,
[src]
K: Eq + Hash,
S: BuildHasher + Default,
impl<'a, K, V, S> Deserialize<'a> for MultiMap<K, V, S> where
K: Deserialize<'a> + Eq + Hash,
V: Deserialize<'a>,
S: BuildHasher + Default,
[src]
K: Deserialize<'a> + Eq + Hash,
V: Deserialize<'a>,
S: BuildHasher + Default,
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
D: Deserializer<'a>,
[src]
D: Deserializer<'a>,
impl<K, V, S> Eq for MultiMap<K, V, S> where
K: Eq + Hash,
V: Eq,
S: BuildHasher,
[src]
K: Eq + Hash,
V: Eq,
S: BuildHasher,
impl<'a, K, V, S> Extend<(&'a K, &'a V)> for MultiMap<K, V, S> where
K: Eq + Hash + Copy,
V: Copy,
S: BuildHasher,
[src]
K: Eq + Hash + Copy,
V: Copy,
S: BuildHasher,
impl<'a, K, V, S> Extend<(&'a K, &'a Vec<V>)> for MultiMap<K, V, S> where
K: Eq + Hash + Copy,
V: Copy,
S: BuildHasher,
[src]
K: Eq + Hash + Copy,
V: Copy,
S: BuildHasher,
impl<K, V, S> Extend<(K, V)> for MultiMap<K, V, S> where
K: Eq + Hash,
S: BuildHasher,
[src]
K: Eq + Hash,
S: BuildHasher,
fn extend<T: IntoIterator<Item = (K, V)>>(&mut self, iter: T)
[src]
impl<K, V, S> Extend<(K, Vec<V>)> for MultiMap<K, V, S> where
K: Eq + Hash,
S: BuildHasher,
[src]
K: Eq + Hash,
S: BuildHasher,
impl<K, V, S> FromIterator<(K, V)> for MultiMap<K, V, S> where
K: Eq + Hash,
S: BuildHasher + Default,
[src]
K: Eq + Hash,
S: BuildHasher + Default,
impl<'a, K, V, S, Q: ?Sized> Index<&'a Q> for MultiMap<K, V, S> where
K: Eq + Hash + Borrow<Q>,
Q: Eq + Hash,
S: BuildHasher,
[src]
K: Eq + Hash + Borrow<Q>,
Q: Eq + Hash,
S: BuildHasher,
impl<'a, K, V, S> IntoIterator for &'a MultiMap<K, V, S> where
K: Eq + Hash,
S: BuildHasher,
[src]
K: Eq + Hash,
S: BuildHasher,
type Item = (&'a K, &'a Vec<V>)
The type of the elements being iterated over.
type IntoIter = IterAll<'a, K, Vec<V>>
Which kind of iterator are we turning this into?
fn into_iter(self) -> IterAll<'a, K, Vec<V>>
[src]
impl<'a, K, V, S> IntoIterator for &'a mut MultiMap<K, V, S> where
K: Eq + Hash,
S: BuildHasher,
[src]
K: Eq + Hash,
S: BuildHasher,
type Item = (&'a K, &'a mut Vec<V>)
The type of the elements being iterated over.
type IntoIter = IterAllMut<'a, K, Vec<V>>
Which kind of iterator are we turning this into?
fn into_iter(self) -> IterAllMut<'a, K, Vec<V>>
[src]
impl<K, V, S> IntoIterator for MultiMap<K, V, S> where
K: Eq + Hash,
S: BuildHasher,
[src]
K: Eq + Hash,
S: BuildHasher,
type Item = (K, Vec<V>)
The type of the elements being iterated over.
type IntoIter = IntoIter<K, Vec<V>>
Which kind of iterator are we turning this into?
fn into_iter(self) -> IntoIter<K, Vec<V>>
[src]
impl<K, V, S> PartialEq<MultiMap<K, V, S>> for MultiMap<K, V, S> where
K: Eq + Hash,
V: PartialEq,
S: BuildHasher,
[src]
K: Eq + Hash,
V: PartialEq,
S: BuildHasher,
fn eq(&self, other: &MultiMap<K, V, S>) -> bool
[src]
#[must_use]fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
impl<K, V, BS> Serialize for MultiMap<K, V, BS> where
K: Serialize + Eq + Hash,
V: Serialize,
BS: BuildHasher,
[src]
K: Serialize + Eq + Hash,
V: Serialize,
BS: BuildHasher,
Auto Trait Implementations
impl<K, V, S> RefUnwindSafe for MultiMap<K, V, S> where
K: RefUnwindSafe,
S: RefUnwindSafe,
V: RefUnwindSafe,
K: RefUnwindSafe,
S: RefUnwindSafe,
V: RefUnwindSafe,
impl<K, V, S> Send for MultiMap<K, V, S> where
K: Send,
S: Send,
V: Send,
K: Send,
S: Send,
V: Send,
impl<K, V, S> Sync for MultiMap<K, V, S> where
K: Sync,
S: Sync,
V: Sync,
K: Sync,
S: Sync,
V: Sync,
impl<K, V, S> Unpin for MultiMap<K, V, S> where
K: Unpin,
S: Unpin,
V: Unpin,
K: Unpin,
S: Unpin,
V: Unpin,
impl<K, V, S> UnwindSafe for MultiMap<K, V, S> where
K: UnwindSafe,
S: UnwindSafe,
V: UnwindSafe,
K: UnwindSafe,
S: UnwindSafe,
V: UnwindSafe,
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> DeserializeOwned for T where
T: Deserialize<'de>,
[src]
T: Deserialize<'de>,
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<I> IntoIterator for I where
I: Iterator,
[src]
I: Iterator,
type Item = <I as Iterator>::Item
The type of the elements being iterated over.
type IntoIter = I
Which kind of iterator are we turning this into?
fn into_iter(self) -> I
[src]
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,