Struct std::collections::VecMapExperimental
[-]
[+]
[src]
pub struct VecMap<T> {
// some fields omitted
}A map optimized for small integer keys.
Example
fn main() { use std::collections::VecMap; let mut months = VecMap::new(); months.insert(1, "Jan"); months.insert(2, "Feb"); months.insert(3, "Mar"); if !months.contains_key(&12) { println!("The end is near!"); } assert_eq!(months.get(&1), Some(&"Jan")); match months.get_mut(&3) { Some(value) => *value = "Venus", None => (), } assert_eq!(months.get(&3), Some(&"Venus")); // Print out all months for (key, value) in months.iter() { println!("month {} is {}", key, value); } months.clear(); assert!(months.is_empty()); }use std::collections::VecMap; let mut months = VecMap::new(); months.insert(1, "Jan"); months.insert(2, "Feb"); months.insert(3, "Mar"); if !months.contains_key(&12) { println!("The end is near!"); } assert_eq!(months.get(&1), Some(&"Jan")); match months.get_mut(&3) { Some(value) => *value = "Venus", None => (), } assert_eq!(months.get(&3), Some(&"Venus")); // Print out all months for (key, value) in months.iter() { println!("month {} is {}", key, value); } months.clear(); assert!(months.is_empty());
Methods
impl<V> VecMap<V>
fn new() -> VecMap<V>
Creates an empty VecMap.
Example
fn main() { use std::collections::VecMap; let mut map: VecMap<&str> = VecMap::new(); }use std::collections::VecMap; let mut map: VecMap<&str> = VecMap::new();
fn with_capacity(capacity: uint) -> VecMap<V>
Creates an empty VecMap with space for at least capacity
elements before resizing.
Example
fn main() { use std::collections::VecMap; let mut map: VecMap<&str> = VecMap::with_capacity(10); }use std::collections::VecMap; let mut map: VecMap<&str> = VecMap::with_capacity(10);
fn keys(&'r self) -> Map<'static, (uint, &'r V), uint, Entries<'r, V>>
Returns an iterator visiting all keys in ascending order by the keys.
The iterator's element type is uint.
fn values(&'r self) -> Map<'static, (uint, &'r V), &'r V, Entries<'r, V>>
Returns an iterator visiting all values in ascending order by the keys.
The iterator's element type is &'r V.
fn iter(&'r self) -> Entries<'r, V>
Returns an iterator visiting all key-value pairs in ascending order by the keys.
The iterator's element type is (uint, &'r V).
Example
fn main() { use std::collections::VecMap; let mut map = VecMap::new(); map.insert(1, "a"); map.insert(3, "c"); map.insert(2, "b"); // Print `1: a` then `2: b` then `3: c` for (key, value) in map.iter() { println!("{}: {}", key, value); } }use std::collections::VecMap; let mut map = VecMap::new(); map.insert(1, "a"); map.insert(3, "c"); map.insert(2, "b"); // Print `1: a` then `2: b` then `3: c` for (key, value) in map.iter() { println!("{}: {}", key, value); }
fn iter_mut(&'r mut self) -> MutEntries<'r, V>
Returns an iterator visiting all key-value pairs in ascending order by the keys,
with mutable references to the values.
The iterator's element type is (uint, &'r mut V).
Example
fn main() { use std::collections::VecMap; let mut map = VecMap::new(); map.insert(1, "a"); map.insert(2, "b"); map.insert(3, "c"); for (key, value) in map.iter_mut() { *value = "x"; } for (key, value) in map.iter() { assert_eq!(value, &"x"); } }use std::collections::VecMap; let mut map = VecMap::new(); map.insert(1, "a"); map.insert(2, "b"); map.insert(3, "c"); for (key, value) in map.iter_mut() { *value = "x"; } for (key, value) in map.iter() { assert_eq!(value, &"x"); }
fn into_iter(&mut self) -> FilterMap<(uint, Option<V>), (uint, V), Enumerate<MoveItems<Option<V>>>>
Returns an iterator visiting all key-value pairs in ascending order by
the keys, emptying (but not consuming) the original VecMap.
The iterator's element type is (uint, &'r V).
Example
fn main() { use std::collections::VecMap; let mut map = VecMap::new(); map.insert(1, "a"); map.insert(3, "c"); map.insert(2, "b"); // Not possible with .iter() let vec: Vec<(uint, &str)> = map.into_iter().collect(); assert_eq!(vec, vec![(1, "a"), (2, "b"), (3, "c")]); }use std::collections::VecMap; let mut map = VecMap::new(); map.insert(1, "a"); map.insert(3, "c"); map.insert(2, "b"); // Not possible with .iter() let vec: Vec<(uint, &str)> = map.into_iter().collect(); assert_eq!(vec, vec![(1, "a"), (2, "b"), (3, "c")]);
fn len(&self) -> uint
Return the number of elements in the map.
Example
fn main() { use std::collections::VecMap; let mut a = VecMap::new(); assert_eq!(a.len(), 0); a.insert(1, "a"); assert_eq!(a.len(), 1); }use std::collections::VecMap; let mut a = VecMap::new(); assert_eq!(a.len(), 0); a.insert(1, "a"); assert_eq!(a.len(), 1);
fn is_empty(&self) -> bool
Return true if the map contains no elements.
Example
fn main() { use std::collections::VecMap; let mut a = VecMap::new(); assert!(a.is_empty()); a.insert(1, "a"); assert!(!a.is_empty()); }use std::collections::VecMap; let mut a = VecMap::new(); assert!(a.is_empty()); a.insert(1, "a"); assert!(!a.is_empty());
fn clear(&mut self)
Clears the map, removing all key-value pairs.
Example
fn main() { use std::collections::VecMap; let mut a = VecMap::new(); a.insert(1, "a"); a.clear(); assert!(a.is_empty()); }use std::collections::VecMap; let mut a = VecMap::new(); a.insert(1, "a"); a.clear(); assert!(a.is_empty());
fn find(&self, key: &uint) -> Option<&V>
Deprecated: Renamed to get.
fn get(&self, key: &uint) -> Option<&V>
Returns a reference to the value corresponding to the key.
Example
fn main() { use std::collections::VecMap; let mut map = VecMap::new(); map.insert(1, "a"); assert_eq!(map.get(&1), Some(&"a")); assert_eq!(map.get(&2), None); }use std::collections::VecMap; let mut map = VecMap::new(); map.insert(1, "a"); assert_eq!(map.get(&1), Some(&"a")); assert_eq!(map.get(&2), None);
fn contains_key(&self, key: &uint) -> bool
Returns true if the map contains a value for the specified key.
Example
fn main() { use std::collections::VecMap; let mut map = VecMap::new(); map.insert(1, "a"); assert_eq!(map.contains_key(&1), true); assert_eq!(map.contains_key(&2), false); }use std::collections::VecMap; let mut map = VecMap::new(); map.insert(1, "a"); assert_eq!(map.contains_key(&1), true); assert_eq!(map.contains_key(&2), false);
fn find_mut(&mut self, key: &uint) -> Option<&mut V>
Deprecated: Renamed to get_mut.
fn get_mut(&mut self, key: &uint) -> Option<&mut V>
Returns a mutable reference to the value corresponding to the key.
Example
fn main() { use std::collections::VecMap; let mut map = VecMap::new(); map.insert(1, "a"); match map.get_mut(&1) { Some(x) => *x = "b", None => (), } assert_eq!(map[1], "b"); }use std::collections::VecMap; let mut map = VecMap::new(); map.insert(1, "a"); match map.get_mut(&1) { Some(x) => *x = "b", None => (), } assert_eq!(map[1], "b");
fn swap(&mut self, key: uint, value: V) -> Option<V>
Deprecated: Renamed to insert.
fn insert(&mut self, key: uint, value: V) -> Option<V>
Inserts a key-value pair from the map. If the key already had a value
present in the map, that value is returned. Otherwise, None is returned.
Example
fn main() { use std::collections::VecMap; let mut map = VecMap::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"); }use std::collections::VecMap; let mut map = VecMap::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");
fn pop(&mut self, key: &uint) -> Option<V>
Deprecated: Renamed to remove.
fn remove(&mut self, key: &uint) -> Option<V>
Removes a key from the map, returning the value at the key if the key was previously in the map.
Example
fn main() { use std::collections::VecMap; let mut map = VecMap::new(); map.insert(1, "a"); assert_eq!(map.remove(&1), Some("a")); assert_eq!(map.remove(&1), None); }use std::collections::VecMap; let mut map = VecMap::new(); map.insert(1, "a"); assert_eq!(map.remove(&1), Some("a")); assert_eq!(map.remove(&1), None);
impl<V: Clone> VecMap<V>
fn update(&mut self, key: uint, newval: V, ff: |V, V| -> V) -> bool
Updates a value in the map. If the key already exists in the map,
modifies the value with ff taking oldval, newval.
Otherwise, sets the value to newval.
Returns true if the key did not already exist in the map.
Example
fn main() { use std::collections::VecMap; let mut map = VecMap::new(); // Key does not exist, will do a simple insert assert!(map.update(1, vec![1i, 2], |mut old, new| { old.extend(new.into_iter()); old })); assert_eq!(map[1], vec![1i, 2]); // Key exists, update the value assert!(!map.update(1, vec![3i, 4], |mut old, new| { old.extend(new.into_iter()); old })); assert_eq!(map[1], vec![1i, 2, 3, 4]); }use std::collections::VecMap; let mut map = VecMap::new(); // Key does not exist, will do a simple insert assert!(map.update(1, vec![1i, 2], |mut old, new| { old.extend(new.into_iter()); old })); assert_eq!(map[1], vec![1i, 2]); // Key exists, update the value assert!(!map.update(1, vec![3i, 4], |mut old, new| { old.extend(new.into_iter()); old })); assert_eq!(map[1], vec![1i, 2, 3, 4]);
fn update_with_key(&mut self, key: uint, val: V, ff: |uint, V, V| -> V) -> bool
Updates a value in the map. If the key already exists in the map,
modifies the value with ff taking key, oldval, newval.
Otherwise, sets the value to newval.
Returns true if the key did not already exist in the map.
Example
fn main() { use std::collections::VecMap; let mut map = VecMap::new(); // Key does not exist, will do a simple insert assert!(map.update_with_key(7, 10, |key, old, new| (old + new) % key)); assert_eq!(map[7], 10); // Key exists, update the value assert!(!map.update_with_key(7, 20, |key, old, new| (old + new) % key)); assert_eq!(map[7], 2); }use std::collections::VecMap; let mut map = VecMap::new(); // Key does not exist, will do a simple insert assert!(map.update_with_key(7, 10, |key, old, new| (old + new) % key)); assert_eq!(map[7], 10); // Key exists, update the value assert!(!map.update_with_key(7, 20, |key, old, new| (old + new) % key)); assert_eq!(map[7], 2);