Struct transient_hashmap::TransientHashMap
[−]
[src]
pub struct TransientHashMap<K, V, T = StandardTimer> where
T: Timer, { /* fields omitted */ }
HashMap
with entries that will be garbage collected (pruned)
after not being used for specified time.
Pruning does not occur automatically, make sure to call prune
method
to remove old entries.
Methods
impl<K, V> TransientHashMap<K, V, StandardTimer> where
K: Eq + Hash + Clone,
[src]
K: Eq + Hash + Clone,
pub fn new(lifetime: u32) -> Self
[src]
Creates new TransientHashMap
with standard timer and specified entries lifetime.
impl<K, V, T> TransientHashMap<K, V, T> where
K: Eq + Hash + Clone,
T: Timer,
[src]
K: Eq + Hash + Clone,
T: Timer,
pub fn new_with_timer(lifetime: u32, t: T) -> Self
[src]
Creates new TransientHashMap
with given timer and specfied entries lifetime.
pub fn insert(&mut self, key: K, value: V) -> Option<V>
[src]
Insert new entry to this map overwriting any previous entry.
Prolongs lifetime of key
.
pub fn entry(&mut self, key: K) -> Entry<K, V>
[src]
Insert new entry to this map overwriting any previous entry.
Always prolongs the lifetime of key
.
TODO [ToDr] Should only prolong if new item is inserted or entry is occupied.
pub fn get(&mut self, key: &K) -> Option<&V>
[src]
Gets reference to stored value.
Prolongs lifetime of key
if is in the map.
pub fn get_mut(&mut self, key: &K) -> Option<&mut V>
[src]
Gets mutable reference to stored value.
Prolongs lifetime of key
if is in the map.
pub fn contains_key(&mut self, key: &K) -> bool
[src]
Checks if key
is contained.
Prolongs lifetime of key
if is in the map.
pub fn remove(&mut self, k: &K) -> Option<V>
[src]
Removes key
from the map if present.
Also removes associated lifetime.
pub fn remaining_lifetime(&mut self, key: &K) -> Option<u32>
[src]
Returns remaining lifetime of key
without altering it.
pub fn prune(&mut self) -> Vec<K>
[src]
Clear overdue entries from the TransientHashMap
.
pub fn direct(&self) -> &HashMap<K, V>
[src]
Get a reference to backing HashMap
.
pub fn direct_mut(&mut self) -> &mut HashMap<K, V>
[src]
Get the mutable reference to backing HashMap
.
Methods from Deref<Target = HashMap<K, V>>
pub fn hasher(&self) -> &S
1.9.0[src]
Returns a reference to the map's BuildHasher
.
Examples
use std::collections::HashMap; use std::collections::hash_map::RandomState; let hasher = RandomState::new(); let map: HashMap<isize, isize> = HashMap::with_hasher(hasher); let hasher: &RandomState = map.hasher();
pub fn capacity(&self) -> usize
1.0.0[src]
Returns the number of elements the map can hold without reallocating.
This number is a lower bound; the HashMap<K, V>
might be able to hold
more, but is guaranteed to be able to hold at least this many.
Examples
use std::collections::HashMap; let map: HashMap<isize, isize> = HashMap::with_capacity(100); assert!(map.capacity() >= 100);
pub fn reserve(&mut self, additional: usize)
1.0.0[src]
Reserves capacity for at least additional
more elements to be inserted
in the HashMap
. The collection may reserve more space to avoid
frequent reallocations.
Panics
Panics if the new allocation size overflows usize
.
Examples
use std::collections::HashMap; let mut map: HashMap<&str, isize> = HashMap::new(); map.reserve(10);
pub fn shrink_to_fit(&mut self)
1.0.0[src]
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.
Examples
use std::collections::HashMap; let mut map: HashMap<isize, isize> = HashMap::with_capacity(100); map.insert(1, 2); map.insert(3, 4); assert!(map.capacity() >= 100); map.shrink_to_fit(); assert!(map.capacity() >= 2);
pub fn keys(&self) -> Keys<K, V>
1.0.0[src]
An iterator visiting all keys in arbitrary order.
The iterator element type is &'a K
.
Examples
use std::collections::HashMap; let mut map = HashMap::new(); map.insert("a", 1); map.insert("b", 2); map.insert("c", 3); for key in map.keys() { println!("{}", key); }
pub fn values(&self) -> Values<K, V>
1.0.0[src]
An iterator visiting all values in arbitrary order.
The iterator element type is &'a V
.
Examples
use std::collections::HashMap; let mut map = HashMap::new(); map.insert("a", 1); map.insert("b", 2); map.insert("c", 3); for val in map.values() { println!("{}", val); }
pub fn values_mut(&mut self) -> ValuesMut<K, V>
1.10.0[src]
An iterator visiting all values mutably in arbitrary order.
The iterator element type is &'a mut V
.
Examples
use std::collections::HashMap; let mut map = HashMap::new(); map.insert("a", 1); map.insert("b", 2); map.insert("c", 3); for val in map.values_mut() { *val = *val + 10; } for val in map.values() { println!("{}", val); }
pub fn iter(&self) -> Iter<K, V>
1.0.0[src]
An iterator visiting all key-value pairs in arbitrary order.
The iterator element type is (&'a K, &'a V)
.
Examples
use std::collections::HashMap; let mut map = HashMap::new(); map.insert("a", 1); map.insert("b", 2); map.insert("c", 3); for (key, val) in map.iter() { println!("key: {} val: {}", key, val); }
pub fn iter_mut(&mut self) -> IterMut<K, V>
1.0.0[src]
An iterator visiting all key-value pairs in arbitrary order,
with mutable references to the values.
The iterator element type is (&'a K, &'a mut V)
.
Examples
use std::collections::HashMap; let mut map = HashMap::new(); map.insert("a", 1); map.insert("b", 2); map.insert("c", 3); // Update all values for (_, val) in map.iter_mut() { *val *= 2; } for (key, val) in &map { println!("key: {} val: {}", key, val); }
pub fn entry(&mut self, key: K) -> Entry<K, V>
1.0.0[src]
Gets the given key's corresponding entry in the map for in-place manipulation.
Examples
use std::collections::HashMap; let mut letters = HashMap::new(); for ch in "a short treatise on fungi".chars() { let counter = letters.entry(ch).or_insert(0); *counter += 1; } assert_eq!(letters[&'s'], 2); assert_eq!(letters[&'t'], 3); assert_eq!(letters[&'u'], 1); assert_eq!(letters.get(&'y'), None);
pub fn len(&self) -> usize
1.0.0[src]
Returns the number of elements in the map.
Examples
use std::collections::HashMap; let mut a = HashMap::new(); assert_eq!(a.len(), 0); a.insert(1, "a"); assert_eq!(a.len(), 1);
pub fn is_empty(&self) -> bool
1.0.0[src]
Returns true if the map contains no elements.
Examples
use std::collections::HashMap; let mut a = HashMap::new(); assert!(a.is_empty()); a.insert(1, "a"); assert!(!a.is_empty());
pub fn drain(&mut self) -> Drain<K, V>
1.6.0[src]
Clears the map, returning all key-value pairs as an iterator. Keeps the allocated memory for reuse.
Examples
use std::collections::HashMap; let mut a = HashMap::new(); a.insert(1, "a"); a.insert(2, "b"); for (k, v) in a.drain().take(1) { assert!(k == 1 || k == 2); assert!(v == "a" || v == "b"); } assert!(a.is_empty());
pub fn clear(&mut self)
1.0.0[src]
Clears the map, removing all key-value pairs. Keeps the allocated memory for reuse.
Examples
use std::collections::HashMap; let mut a = HashMap::new(); a.insert(1, "a"); a.clear(); assert!(a.is_empty());
pub fn get<Q>(&self, k: &Q) -> Option<&V> where
K: Borrow<Q>,
Q: Hash + Eq + ?Sized,
1.0.0[src]
K: Borrow<Q>,
Q: Hash + Eq + ?Sized,
Returns a reference to the value 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 std::collections::HashMap; let mut map = HashMap::new(); map.insert(1, "a"); assert_eq!(map.get(&1), Some(&"a")); assert_eq!(map.get(&2), None);
pub fn contains_key<Q>(&self, k: &Q) -> bool where
K: Borrow<Q>,
Q: Hash + Eq + ?Sized,
1.0.0[src]
K: Borrow<Q>,
Q: Hash + Eq + ?Sized,
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 std::collections::HashMap; let mut map = HashMap::new(); map.insert(1, "a"); assert_eq!(map.contains_key(&1), true); assert_eq!(map.contains_key(&2), false);
pub fn get_mut<Q>(&mut self, k: &Q) -> Option<&mut V> where
K: Borrow<Q>,
Q: Hash + Eq + ?Sized,
1.0.0[src]
K: Borrow<Q>,
Q: Hash + Eq + ?Sized,
Returns a mutable reference to the value 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 std::collections::HashMap; let mut map = HashMap::new(); map.insert(1, "a"); if let Some(x) = map.get_mut(&1) { *x = "b"; } assert_eq!(map[&1], "b");
pub fn insert(&mut self, k: K, v: V) -> Option<V>
1.0.0[src]
Inserts a key-value pair into the map.
If the map did not have this key present, None
is returned.
If the map did have this key present, the value is updated, and the old
value is returned. The key is not updated, though; this matters for
types that can be ==
without being identical. See the module-level
documentation for more.
Examples
use std::collections::HashMap; let mut map = HashMap::new(); assert_eq!(map.insert(37, "a"), None); assert_eq!(map.is_empty(), false); map.insert(37, "b"); assert_eq!(map.insert(37, "c"), Some("b")); assert_eq!(map[&37], "c");
pub fn remove<Q>(&mut self, k: &Q) -> Option<V> where
K: Borrow<Q>,
Q: Hash + Eq + ?Sized,
1.0.0[src]
K: Borrow<Q>,
Q: Hash + Eq + ?Sized,
Removes a key from the map, returning the value 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 std::collections::HashMap; let mut map = HashMap::new(); map.insert(1, "a"); assert_eq!(map.remove(&1), Some("a")); assert_eq!(map.remove(&1), None);
pub fn retain<F>(&mut self, f: F) where
F: FnMut(&K, &mut V) -> bool,
1.18.0[src]
F: FnMut(&K, &mut 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 std::collections::HashMap; let mut map: HashMap<isize, isize> = (0..8).map(|x|(x, x*10)).collect(); map.retain(|&k, _| k % 2 == 0); assert_eq!(map.len(), 4);
Trait Implementations
impl<K, V, T> Deref for TransientHashMap<K, V, T> where
T: Timer,
[src]
T: Timer,
type Target = HashMap<K, V>
The resulting type after dereferencing.
fn deref(&self) -> &Self::Target
[src]
Dereferences the value.
impl<K, V, T> DerefMut for TransientHashMap<K, V, T> where
T: Timer,
[src]
T: Timer,