Struct im::hashmap::HashMap [] [src]

pub struct HashMap<K, V, S = RandomState> { /* fields omitted */ }

A hash map.

An immutable hash map using hash array mapped tries.

Most operations on this map are O(logx n) for a suitably high x that it should be nearly O(1) for most maps. Because of this, it's a great choice for a generic map as long as you don't mind that keys will need to implement Hash and Eq.

Map entries will have a predictable order based on the hasher being used. Unless otherwise specified, all maps will share an instance of the default RandomState hasher, which will produce consistent hashes for the duration of its lifetime, but not between restarts of your program.

Methods

impl<K, V> HashMap<K, V, RandomState> where
    K: Hash + Eq
[src]

[src]

Construct an empty hash map.

[src]

Construct a hash map with a single mapping.

Examples

let map = HashMap::singleton(123, "onetwothree");
assert_eq!(
  map.get(&123),
  Some(Arc::new("onetwothree"))
);

impl<K, V, S> HashMap<K, V, S>
[src]

[src]

Test whether a hash map is empty.

Time: O(1)

Examples

assert!(
  !hashmap!{1 => 2}.is_empty()
);
assert!(
  HashMap::<i32, i32>::new().is_empty()
);

[src]

Get the size of a hash map.

Time: O(1)

Examples

assert_eq!(3, hashmap!{
  1 => 11,
  2 => 22,
  3 => 33
}.len());

impl<K, V, S> HashMap<K, V, S> where
    K: Hash + Eq,
    S: BuildHasher
[src]

[src]

Construct an empty hash map using the provided hasher.

[src]

Construct an empty hash map using the same hasher as the current hash map.

[src]

Get an iterator over the key/value pairs of a hash map.

Please note that the order is consistent between maps using the same hasher, but no other ordering guarantee is offered. Items will not come out in insertion order or sort order. They will, however, come out in the same order every time for the same map.

Important traits for Keys<K, V>
[src]

Get an iterator over a hash map's keys.

Please note that the order is consistent between maps using the same hasher, but no other ordering guarantee is offered. Items will not come out in insertion order or sort order. They will, however, come out in the same order every time for the same map.

Important traits for Values<K, V>
[src]

Get an iterator over a hash map's values.

Please note that the order is consistent between maps using the same hasher, but no other ordering guarantee is offered. Items will not come out in insertion order or sort order. They will, however, come out in the same order every time for the same map.

[src]

Get the value for a key from a hash map.

Time: O(log n)

Examples

let map = hashmap!{123 => "lol"};
assert_eq!(
  map.get(&123),
  Some(Arc::new("lol"))
);

[src]

Get the value for a key from a hash map, or a default value if the key isn't in the map.

Time: O(log n)

Examples

let map = hashmap!{123 => "lol"};
assert_eq!(
  map.get_or(&123, "hi"),
  Arc::new("lol")
);
assert_eq!(
  map.get_or(&321, "hi"),
  Arc::new("hi")
);

[src]

Test for the presence of a key in a hash map.

Time: O(log n)

Examples

let map = hashmap!{123 => "lol"};
assert!(
  map.contains_key(&123)
);
assert!(
  !map.contains_key(&321)
);

[src]

Construct a new hash map by inserting a key/value mapping into a map.

If the map already has a mapping for the given key, the previous value is overwritten.

Time: O(log n)

Examples

let map = hashmap!{};
assert_eq!(
  map.insert(123, "123"),
  hashmap!{123 => "123"}
);

[src]

Insert a key/value mapping into a map.

If the map already has a mapping for the given key, the previous value is overwritten.

This is a copy-on-write operation, so that the parts of the set's structure which are shared with other sets will be safely copied before mutating.

Time: O(log n)

Examples

let mut map = hashmap!{};
map.insert_mut(123, "123");
map.insert_mut(456, "456");
assert_eq!(
  map,
  hashmap!{123 => "123", 456 => "456"}
);

[src]

Construct a new map by inserting a key/value mapping into a map.

This is an alias for insert.

Time: O(log n)

[src]

Insert a key/value mapping into a map, mutating it in place when it is safe to do so.

This is an alias for insert_mut.

Time: O(log n)

[src]

Construct a new hash map by inserting a key/value mapping into a map.

If the map already has a mapping for the given key, we call the provided function with the old value and the new value, and insert the result as the new value.

Time: O(log n)

[src]

Construct a new map by inserting a key/value mapping into a map.

If the map already has a mapping for the given key, we call the provided function with the key, the old value and the new value, and insert the result as the new value.

Time: O(log n)

[src]

Construct a new map by inserting a key/value mapping into a map, returning the old value for the key as well as the new map.

If the map already has a mapping for the given key, we call the provided function with the key, the old value and the new value, and insert the result as the new value.

Time: O(log n)

[src]

Update the value for a given key by calling a function with the current value and overwriting it with the function's return value.

Time: O(log n)

[src]

Update the value for a given key by calling a function with the key and the current value and overwriting it with the function's return value.

Time: O(log n)

[src]

Update the value for a given key by calling a function with the key and the current value and overwriting it with the function's return value.

If the key was not in the map, the function is never called and the map is left unchanged.

Return a tuple of the old value, if there was one, and the new map.

Time: O(log n)

[src]

Update the value for a given key by calling a function with the current value and overwriting it with the function's return value.

This is like the update method, except with more control: the function gets an Option<V> and returns the same, so that it can decide to delete a mapping instead of updating the value, and decide what to do if the key isn't in the map.

Time: O(log n)

[src]

Remove a key/value pair from a hash map, if it exists.

Time: O(log n)

[src]

Remove a key/value mapping from a map if it exists.

This is a copy-on-write operation, so that the parts of the set's structure which are shared with other sets will be safely copied before mutating.

Time: O(log n)

Examples

let mut map = hashmap!{123 => "123", 456 => "456"};
map.remove_mut(&123);
map.remove_mut(&456);
assert!(map.is_empty());

[src]

Remove a key/value pair from a map, if it exists, and return the removed value as well as the updated list.

Time: O(log n)

[src]

Remove a key/value pair from a map, if it exists, and return the removed value.

This is a copy-on-write operation, so that the parts of the set's structure which are shared with other sets will be safely copied before mutating.

Time: O(log n)

[src]

Remove a key/value pair from a map, if it exists, and return the removed key and value as well as the updated list.

Time: O(log n)

[src]

Remove a key/value pair from a map, if it exists, and return the removed key and value.

This is a copy-on-write operation, so that the parts of the set's structure which are shared with other sets will be safely copied before mutating.

Time: O(log n)

[src]

Construct the union of two maps, keeping the values in the current map when keys exist in both maps.

[src]

Construct the union of two maps, using a function to decide what to do with the value when a key is in both maps.

[src]

Construct the union of two maps, using a function to decide what to do with the value when a key is in both maps. The function receives the key as well as both values.

[src]

Construct the union of a sequence of maps, selecting the value of the leftmost when a key appears in more than one map.

[src]

Construct the union of a sequence of maps, using a function to decide what to do with the value when a key is in more than one map.

[src]

Construct the union of a sequence of maps, using a function to decide what to do with the value when a key is in more than one map. The function receives the key as well as both values.

[src]

Construct the difference between two maps by discarding keys which occur in both maps.

[src]

Construct the difference between two maps by using a function to decide what to do if a key occurs in both.

[src]

Construct the difference between two maps by using a function to decide what to do if a key occurs in both. The function receives the key as well as both values.

[src]

Construct the intersection of two maps, keeping the values from the current map.

[src]

Construct the intersection of two maps, calling a function with both values for each key and using the result as the value for the key.

[src]

Construct the intersection of two maps, calling a function with the key and both values for each key and using the result as the value for the key.

[src]

Merge two maps.

First, we call the combine function for each key/value pair which exists in both maps, updating the value or discarding it according to the function's return value.

The only1 and only2 functions are called with the key/value pairs which are only in the first and the second list respectively. The results of these are then merged with the result of the first operation.

[src]

Test whether a map is a submap of another map, meaning that all keys in our map must also be in the other map, with the same values.

Use the provided function to decide whether values are equal.

[src]

Test whether a map is a proper submap of another map, meaning that all keys in our map must also be in the other map, with the same values. To be a proper submap, ours must also contain fewer keys than the other map.

Use the provided function to decide whether values are equal.

[src]

Test whether a map is a submap of another map, meaning that all keys in our map must also be in the other map, with the same values.

[src]

Test whether a map is a proper submap of another map, meaning that all keys in our map must also be in the other map, with the same values. To be a proper submap, ours must also contain fewer keys than the other map.

Trait Implementations

impl<K: Ord + Hash + Eq, V, S: BuildHasher> From<HashMap<K, V, S>> for OrdMap<K, V>
[src]

[src]

Performs the conversion.

impl<'a, K: Ord + Hash + Eq, V, S: BuildHasher> From<&'a HashMap<K, V, S>> for OrdMap<K, V>
[src]

[src]

Performs the conversion.

impl<K, V, S> Clone for HashMap<K, V, S>
[src]

[src]

Returns a copy of the value. Read more

1.0.0
[src]

Performs copy-assignment from source. Read more

impl<K, V, S> PartialEq for HashMap<K, V, S> where
    K: Hash + Eq,
    V: PartialEq,
    S: BuildHasher
[src]

[src]

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0
[src]

This method tests for !=.

impl<K: Hash + Eq, V: Eq, S: BuildHasher> Eq for HashMap<K, V, S>
[src]

impl<K, V, S> PartialOrd for HashMap<K, V, S> where
    K: Hash + Eq + PartialOrd,
    V: PartialOrd,
    S: BuildHasher
[src]

[src]

This method returns an ordering between self and other values if one exists. Read more

1.0.0
[src]

This method tests less than (for self and other) and is used by the < operator. Read more

1.0.0
[src]

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0
[src]

This method tests greater than (for self and other) and is used by the > operator. Read more

1.0.0
[src]

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

impl<K, V, S> Ord for HashMap<K, V, S> where
    K: Hash + Eq + Ord,
    V: Ord,
    S: BuildHasher
[src]

[src]

This method returns an Ordering between self and other. Read more

1.21.0
[src]

Compares and returns the maximum of two values. Read more

1.21.0
[src]

Compares and returns the minimum of two values. Read more

impl<K, V, S> Hash for HashMap<K, V, S> where
    K: Hash + Eq,
    V: Hash,
    S: BuildHasher
[src]

[src]

Feeds this value into the given [Hasher]. Read more

1.3.0
[src]

Feeds a slice of this type into the given [Hasher]. Read more

impl<K, V, S> Default for HashMap<K, V, S> where
    K: Hash + Eq,
    S: BuildHasher + Default
[src]

[src]

Returns the "default value" for a type. Read more

impl<K, V, S> Add for HashMap<K, V, S> where
    K: Hash + Eq,
    S: BuildHasher
[src]

The resulting type after applying the + operator.

[src]

Performs the + operation.

impl<'a, K, V, S> Add for &'a HashMap<K, V, S> where
    K: Hash + Eq,
    S: BuildHasher
[src]

The resulting type after applying the + operator.

[src]

Performs the + operation.

impl<K, V, S> Sum for HashMap<K, V, S> where
    K: Hash + Eq,
    S: BuildHasher + Default
[src]

[src]

Method which takes an iterator and generates Self from the elements by "summing up" the items. Read more

impl<K, V, S, RK, RV> Extend<(RK, RV)> for HashMap<K, V, S> where
    K: Hash + Eq,
    S: BuildHasher,
    RK: Shared<K>,
    RV: Shared<V>, 
[src]

[src]

Extends a collection with the contents of an iterator. Read more

impl<'a, BK: ?Sized, K, V, S> Index<&'a BK> for HashMap<K, V, S> where
    BK: Hash + Eq,
    K: Hash + Eq + Borrow<BK>,
    S: BuildHasher
[src]

The returned type after indexing.

[src]

Performs the indexing (container[index]) operation.

impl<'a, BK: ?Sized, K, V, S> IndexMut<&'a BK> for HashMap<K, V, S> where
    BK: Hash + Eq,
    K: Hash + Eq + Borrow<BK>,
    V: Clone,
    S: BuildHasher
[src]

[src]

Performs the mutable indexing (container[index]) operation.

impl<K, V, S> Debug for HashMap<K, V, S> where
    K: Hash + Eq + Debug,
    V: Debug,
    S: BuildHasher
[src]

[src]

Formats the value using the given formatter. Read more

impl<'a, K, V, S> IntoIterator for &'a HashMap<K, V, S> where
    K: Hash + Eq,
    S: BuildHasher
[src]

The type of the elements being iterated over.

Which kind of iterator are we turning this into?

[src]

Creates an iterator from a value. Read more

impl<K, V, S> IntoIterator for HashMap<K, V, S> where
    K: Hash + Eq,
    S: BuildHasher
[src]

The type of the elements being iterated over.

Which kind of iterator are we turning this into?

[src]

Creates an iterator from a value. Read more

impl<K, V, RK, RV, S> FromIterator<(RK, RV)> for HashMap<K, V, S> where
    K: Hash + Eq,
    RK: Shared<K>,
    RV: Shared<V>,
    S: BuildHasher + Default
[src]

[src]

Creates a value from an iterator. Read more

impl<K, V, S> AsRef<HashMap<K, V, S>> for HashMap<K, V, S>
[src]

[src]

Performs the conversion.

impl<'m, 'k, 'v, K: ?Sized, V: ?Sized, OK, OV, SA, SB> From<&'m HashMap<&'k K, &'v V, SA>> for HashMap<OK, OV, SB> where
    K: Hash + Eq + ToOwned<Owned = OK>,
    V: ToOwned<Owned = OV>,
    OK: Hash + Eq + Borrow<K>,
    OV: Borrow<V>,
    SA: BuildHasher,
    SB: BuildHasher + Default
[src]

[src]

Performs the conversion.

impl<'a, K: Hash + Eq, V: Clone, RK, RV, S> From<&'a [(RK, RV)]> for HashMap<K, V, S> where
    &'a RK: Shared<K>,
    &'a RV: Shared<V>,
    S: BuildHasher + Default
[src]

[src]

Performs the conversion.

impl<K: Hash + Eq, V, RK, RV, S> From<Vec<(RK, RV)>> for HashMap<K, V, S> where
    RK: Shared<K>,
    RV: Shared<V>,
    S: BuildHasher + Default
[src]

[src]

Performs the conversion.

impl<'a, K: Hash + Eq, V, RK, RV, S> From<&'a Vec<(RK, RV)>> for HashMap<K, V, S> where
    &'a RK: Shared<K>,
    &'a RV: Shared<V>,
    S: BuildHasher + Default
[src]

[src]

Performs the conversion.

impl<K: Hash + Eq, V, RK: Hash + Eq, RV, S> From<HashMap<RK, RV>> for HashMap<K, V, S> where
    RK: Shared<K>,
    RV: Shared<V>,
    S: BuildHasher + Default
[src]

[src]

Performs the conversion.

impl<'a, K: Hash + Eq, V, RK: Hash + Eq, RV, S> From<&'a HashMap<RK, RV>> for HashMap<K, V, S> where
    &'a RK: Shared<K>,
    &'a RV: Shared<V>,
    S: BuildHasher + Default
[src]

[src]

Performs the conversion.

impl<K: Hash + Eq, V, RK, RV, S> From<BTreeMap<RK, RV>> for HashMap<K, V, S> where
    RK: Shared<K>,
    RV: Shared<V>,
    S: BuildHasher + Default
[src]

[src]

Performs the conversion.

impl<'a, K: Hash + Eq, V, RK, RV, S> From<&'a BTreeMap<RK, RV>> for HashMap<K, V, S> where
    &'a RK: Shared<K>,
    &'a RV: Shared<V>,
    S: BuildHasher + Default
[src]

[src]

Performs the conversion.

Auto Trait Implementations

impl<K, V, S> Send for HashMap<K, V, S> where
    K: Send + Sync,
    S: Send + Sync,
    V: Send + Sync

impl<K, V, S> Sync for HashMap<K, V, S> where
    K: Send + Sync,
    S: Send + Sync,
    V: Send + Sync