1 // Copyright 2014-2015 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
12 use self::VacantEntryState::*;
17 use fmt::{self, Debug};
19 use hash::{Hash, Hasher, BuildHasher, SipHasher13};
20 use iter::{FromIterator, FusedIterator};
21 use mem::{self, replace};
22 use ops::{Deref, Index, InPlace, Place, Placer};
23 use rand::{self, Rng};
26 use super::table::{self, Bucket, EmptyBucket, FullBucket, FullBucketMut, RawTable, SafeHash};
27 use super::table::BucketState::{Empty, Full};
29 const MIN_NONZERO_RAW_CAPACITY: usize = 32; // must be a power of two
31 /// The default behavior of HashMap implements a maximum load factor of 90.9%.
33 struct DefaultResizePolicy;
35 impl DefaultResizePolicy {
36 fn new() -> DefaultResizePolicy {
40 /// A hash map's "capacity" is the number of elements it can hold without
41 /// being resized. Its "raw capacity" is the number of slots required to
42 /// provide that capacity, accounting for maximum loading. The raw capacity
43 /// is always zero or a power of two.
45 fn raw_capacity(&self, len: usize) -> usize {
49 // 1. Account for loading: `raw_capacity >= len * 1.1`.
50 // 2. Ensure it is a power of two.
51 // 3. Ensure it is at least the minimum size.
52 let mut raw_cap = len * 11 / 10;
53 assert!(raw_cap >= len, "raw_cap overflow");
54 raw_cap = raw_cap.checked_next_power_of_two().expect("raw_capacity overflow");
55 raw_cap = max(MIN_NONZERO_RAW_CAPACITY, raw_cap);
60 /// The capacity of the given raw capacity.
62 fn capacity(&self, raw_cap: usize) -> usize {
63 // This doesn't have to be checked for overflow since allocation size
64 // in bytes will overflow earlier than multiplication by 10.
66 // As per https://github.com/rust-lang/rust/pull/30991 this is updated
67 // to be: (raw_cap * den + den - 1) / num
68 (raw_cap * 10 + 10 - 1) / 11
72 // The main performance trick in this hashmap is called Robin Hood Hashing.
73 // It gains its excellent performance from one essential operation:
75 // If an insertion collides with an existing element, and that element's
76 // "probe distance" (how far away the element is from its ideal location)
77 // is higher than how far we've already probed, swap the elements.
79 // This massively lowers variance in probe distance, and allows us to get very
80 // high load factors with good performance. The 90% load factor I use is rather
83 // > Why a load factor of approximately 90%?
85 // In general, all the distances to initial buckets will converge on the mean.
86 // At a load factor of α, the odds of finding the target bucket after k
87 // probes is approximately 1-α^k. If we set this equal to 50% (since we converge
88 // on the mean) and set k=8 (64-byte cache line / 8-byte hash), α=0.92. I round
89 // this down to make the math easier on the CPU and avoid its FPU.
90 // Since on average we start the probing in the middle of a cache line, this
91 // strategy pulls in two cache lines of hashes on every lookup. I think that's
92 // pretty good, but if you want to trade off some space, it could go down to one
93 // cache line on average with an α of 0.84.
95 // > Wait, what? Where did you get 1-α^k from?
97 // On the first probe, your odds of a collision with an existing element is α.
98 // The odds of doing this twice in a row is approximately α^2. For three times,
99 // α^3, etc. Therefore, the odds of colliding k times is α^k. The odds of NOT
100 // colliding after k tries is 1-α^k.
102 // The paper from 1986 cited below mentions an implementation which keeps track
103 // of the distance-to-initial-bucket histogram. This approach is not suitable
104 // for modern architectures because it requires maintaining an internal data
105 // structure. This allows very good first guesses, but we are most concerned
106 // with guessing entire cache lines, not individual indexes. Furthermore, array
107 // accesses are no longer linear and in one direction, as we have now. There
108 // is also memory and cache pressure that this would entail that would be very
109 // difficult to properly see in a microbenchmark.
111 // ## Future Improvements (FIXME!)
113 // Allow the load factor to be changed dynamically and/or at initialization.
115 // Also, would it be possible for us to reuse storage when growing the
116 // underlying table? This is exactly the use case for 'realloc', and may
117 // be worth exploring.
119 // ## Future Optimizations (FIXME!)
121 // Another possible design choice that I made without any real reason is
122 // parameterizing the raw table over keys and values. Technically, all we need
123 // is the size and alignment of keys and values, and the code should be just as
124 // efficient (well, we might need one for power-of-two size and one for not...).
125 // This has the potential to reduce code bloat in rust executables, without
126 // really losing anything except 4 words (key size, key alignment, val size,
127 // val alignment) which can be passed in to every call of a `RawTable` function.
128 // This would definitely be an avenue worth exploring if people start complaining
129 // about the size of rust executables.
131 // Annotate exceedingly likely branches in `table::make_hash`
132 // and `search_hashed` to reduce instruction cache pressure
133 // and mispredictions once it becomes possible (blocked on issue #11092).
135 // Shrinking the table could simply reallocate in place after moving buckets
136 // to the first half.
138 // The growth algorithm (fragment of the Proof of Correctness)
139 // --------------------
141 // The growth algorithm is basically a fast path of the naive reinsertion-
142 // during-resize algorithm. Other paths should never be taken.
144 // Consider growing a robin hood hashtable of capacity n. Normally, we do this
145 // by allocating a new table of capacity `2n`, and then individually reinsert
146 // each element in the old table into the new one. This guarantees that the
147 // new table is a valid robin hood hashtable with all the desired statistical
148 // properties. Remark that the order we reinsert the elements in should not
149 // matter. For simplicity and efficiency, we will consider only linear
150 // reinsertions, which consist of reinserting all elements in the old table
151 // into the new one by increasing order of index. However we will not be
152 // starting our reinsertions from index 0 in general. If we start from index
153 // i, for the purpose of reinsertion we will consider all elements with real
154 // index j < i to have virtual index n + j.
156 // Our hash generation scheme consists of generating a 64-bit hash and
157 // truncating the most significant bits. When moving to the new table, we
158 // simply introduce a new bit to the front of the hash. Therefore, if an
159 // elements has ideal index i in the old table, it can have one of two ideal
160 // locations in the new table. If the new bit is 0, then the new ideal index
161 // is i. If the new bit is 1, then the new ideal index is n + i. Intuitively,
162 // we are producing two independent tables of size n, and for each element we
163 // independently choose which table to insert it into with equal probability.
164 // However the rather than wrapping around themselves on overflowing their
165 // indexes, the first table overflows into the first, and the first into the
166 // second. Visually, our new table will look something like:
168 // [yy_xxx_xxxx_xxx|xx_yyy_yyyy_yyy]
170 // Where x's are elements inserted into the first table, y's are elements
171 // inserted into the second, and _'s are empty sections. We now define a few
172 // key concepts that we will use later. Note that this is a very abstract
173 // perspective of the table. A real resized table would be at least half
176 // Theorem: A linear robin hood reinsertion from the first ideal element
177 // produces identical results to a linear naive reinsertion from the same
180 // FIXME(Gankro, pczarn): review the proof and put it all in a separate README.md
182 // Adaptive early resizing
183 // ----------------------
184 // To protect against degenerate performance scenarios (including DOS attacks),
185 // the implementation includes an adaptive behavior that can resize the map
186 // early (before its capacity is exceeded) when suspiciously long probe sequences
189 // With this algorithm in place it would be possible to turn a CPU attack into
190 // a memory attack due to the aggressive resizing. To prevent that the
191 // adaptive behavior only triggers when the map is at least half full.
192 // This reduces the effectiveness of the algorithm but also makes it completely safe.
194 // The previous safety measure also prevents degenerate interactions with
195 // really bad quality hash algorithms that can make normal inputs look like a
198 const DISPLACEMENT_THRESHOLD: usize = 128;
200 // The threshold of 128 is chosen to minimize the chance of exceeding it.
201 // In particular, we want that chance to be less than 10^-8 with a load of 90%.
202 // For displacement, the smallest constant that fits our needs is 90,
203 // so we round that up to 128.
205 // At a load factor of α, the odds of finding the target bucket after exactly n
206 // unsuccessful probes[1] are
208 // Pr_α{displacement = n} =
209 // (1 - α) / α * ∑_{k≥1} e^(-kα) * (kα)^(k+n) / (k + n)! * (1 - kα / (k + n + 1))
211 // We use this formula to find the probability of triggering the adaptive behavior
213 // Pr_0.909{displacement > 128} = 1.601 * 10^-11
215 // 1. Alfredo Viola (2005). Distributional analysis of Robin Hood linear probing
216 // hashing with buckets.
218 /// A hash map implemented with linear probing and Robin Hood bucket stealing.
220 /// By default, `HashMap` uses a hashing algorithm selected to provide
221 /// resistance against HashDoS attacks. The algorithm is randomly seeded, and a
222 /// reasonable best-effort is made to generate this seed from a high quality,
223 /// secure source of randomness provided by the host without blocking the
224 /// program. Because of this, the randomness of the seed depends on the output
225 /// quality of the system's random number generator when the seed is created.
226 /// In particular, seeds generated when the system's entropy pool is abnormally
227 /// low such as during system boot may be of a lower quality.
229 /// The default hashing algorithm is currently SipHash 1-3, though this is
230 /// subject to change at any point in the future. While its performance is very
231 /// competitive for medium sized keys, other hashing algorithms will outperform
232 /// it for small keys such as integers as well as large keys such as long
233 /// strings, though those algorithms will typically *not* protect against
234 /// attacks such as HashDoS.
236 /// The hashing algorithm can be replaced on a per-`HashMap` basis using the
237 /// [`default`], [`with_hasher`], and [`with_capacity_and_hasher`] methods. Many
238 /// alternative algorithms are available on crates.io, such as the [`fnv`] crate.
240 /// It is required that the keys implement the [`Eq`] and [`Hash`] traits, although
241 /// this can frequently be achieved by using `#[derive(PartialEq, Eq, Hash)]`.
242 /// If you implement these yourself, it is important that the following
246 /// k1 == k2 -> hash(k1) == hash(k2)
249 /// In other words, if two keys are equal, their hashes must be equal.
251 /// It is a logic error for a key to be modified in such a way that the key's
252 /// hash, as determined by the [`Hash`] trait, or its equality, as determined by
253 /// the [`Eq`] trait, changes while it is in the map. This is normally only
254 /// possible through [`Cell`], [`RefCell`], global state, I/O, or unsafe code.
256 /// Relevant papers/articles:
258 /// 1. Pedro Celis. ["Robin Hood Hashing"](https://cs.uwaterloo.ca/research/tr/1986/CS-86-14.pdf)
259 /// 2. Emmanuel Goossaert. ["Robin Hood
260 /// hashing"](http://codecapsule.com/2013/11/11/robin-hood-hashing/)
261 /// 3. Emmanuel Goossaert. ["Robin Hood hashing: backward shift
262 /// deletion"](http://codecapsule.com/2013/11/17/robin-hood-hashing-backward-shift-deletion/)
267 /// use std::collections::HashMap;
269 /// // type inference lets us omit an explicit type signature (which
270 /// // would be `HashMap<&str, &str>` in this example).
271 /// let mut book_reviews = HashMap::new();
273 /// // review some books.
274 /// book_reviews.insert("Adventures of Huckleberry Finn", "My favorite book.");
275 /// book_reviews.insert("Grimms' Fairy Tales", "Masterpiece.");
276 /// book_reviews.insert("Pride and Prejudice", "Very enjoyable.");
277 /// book_reviews.insert("The Adventures of Sherlock Holmes", "Eye lyked it alot.");
279 /// // check for a specific one.
280 /// if !book_reviews.contains_key("Les Misérables") {
281 /// println!("We've got {} reviews, but Les Misérables ain't one.",
282 /// book_reviews.len());
285 /// // oops, this review has a lot of spelling mistakes, let's delete it.
286 /// book_reviews.remove("The Adventures of Sherlock Holmes");
288 /// // look up the values associated with some keys.
289 /// let to_find = ["Pride and Prejudice", "Alice's Adventure in Wonderland"];
290 /// for book in &to_find {
291 /// match book_reviews.get(book) {
292 /// Some(review) => println!("{}: {}", book, review),
293 /// None => println!("{} is unreviewed.", book)
297 /// // iterate over everything.
298 /// for (book, review) in &book_reviews {
299 /// println!("{}: \"{}\"", book, review);
303 /// `HashMap` also implements an [`Entry API`](#method.entry), which allows
304 /// for more complex methods of getting, setting, updating and removing keys and
308 /// use std::collections::HashMap;
310 /// // type inference lets us omit an explicit type signature (which
311 /// // would be `HashMap<&str, u8>` in this example).
312 /// let mut player_stats = HashMap::new();
314 /// fn random_stat_buff() -> u8 {
315 /// // could actually return some random value here - let's just return
316 /// // some fixed value for now
320 /// // insert a key only if it doesn't already exist
321 /// player_stats.entry("health").or_insert(100);
323 /// // insert a key using a function that provides a new value only if it
324 /// // doesn't already exist
325 /// player_stats.entry("defence").or_insert_with(random_stat_buff);
327 /// // update a key, guarding against the key possibly not being set
328 /// let stat = player_stats.entry("attack").or_insert(100);
329 /// *stat += random_stat_buff();
332 /// The easiest way to use `HashMap` with a custom type as key is to derive [`Eq`] and [`Hash`].
333 /// We must also derive [`PartialEq`].
335 /// [`Eq`]: ../../std/cmp/trait.Eq.html
336 /// [`Hash`]: ../../std/hash/trait.Hash.html
337 /// [`PartialEq`]: ../../std/cmp/trait.PartialEq.html
338 /// [`RefCell`]: ../../std/cell/struct.RefCell.html
339 /// [`Cell`]: ../../std/cell/struct.Cell.html
340 /// [`default`]: #method.default
341 /// [`with_hasher`]: #method.with_hasher
342 /// [`with_capacity_and_hasher`]: #method.with_capacity_and_hasher
343 /// [`fnv`]: https://crates.io/crates/fnv
346 /// use std::collections::HashMap;
348 /// #[derive(Hash, Eq, PartialEq, Debug)]
355 /// /// Create a new Viking.
356 /// fn new(name: &str, country: &str) -> Viking {
357 /// Viking { name: name.to_string(), country: country.to_string() }
361 /// // Use a HashMap to store the vikings' health points.
362 /// let mut vikings = HashMap::new();
364 /// vikings.insert(Viking::new("Einar", "Norway"), 25);
365 /// vikings.insert(Viking::new("Olaf", "Denmark"), 24);
366 /// vikings.insert(Viking::new("Harald", "Iceland"), 12);
368 /// // Use derived implementation to print the status of the vikings.
369 /// for (viking, health) in &vikings {
370 /// println!("{:?} has {} hp", viking, health);
374 /// A `HashMap` with fixed list of elements can be initialized from an array:
377 /// use std::collections::HashMap;
380 /// let timber_resources: HashMap<&str, i32> =
381 /// [("Norway", 100),
384 /// .iter().cloned().collect();
385 /// // use the values stored in map
390 #[stable(feature = "rust1", since = "1.0.0")]
391 pub struct HashMap<K, V, S = RandomState> {
392 // All hashes are keyed on these values, to prevent hash collision attacks.
395 table: RawTable<K, V>,
397 resize_policy: DefaultResizePolicy,
400 /// Search for a pre-hashed key.
402 fn search_hashed<K, V, M, F>(table: M, hash: SafeHash, mut is_match: F) -> InternalEntry<K, V, M>
403 where M: Deref<Target = RawTable<K, V>>,
406 // This is the only function where capacity can be zero. To avoid
407 // undefined behavior when Bucket::new gets the raw bucket in this
408 // case, immediately return the appropriate search result.
409 if table.capacity() == 0 {
410 return InternalEntry::TableIsEmpty;
413 let size = table.size();
414 let mut probe = Bucket::new(table, hash);
415 let mut displacement = 0;
418 let full = match probe.peek() {
421 return InternalEntry::Vacant {
423 elem: NoElem(bucket, displacement),
426 Full(bucket) => bucket,
429 let probe_displacement = full.displacement();
431 if probe_displacement < displacement {
432 // Found a luckier bucket than me.
433 // We can finish the search early if we hit any bucket
434 // with a lower distance to initial bucket than we've probed.
435 return InternalEntry::Vacant {
437 elem: NeqElem(full, probe_displacement),
441 // If the hash doesn't match, it can't be this one..
442 if hash == full.hash() {
443 // If the key doesn't match, it can't be this one..
444 if is_match(full.read().0) {
445 return InternalEntry::Occupied { elem: full };
450 debug_assert!(displacement <= size);
454 fn pop_internal<K, V>(starting_bucket: FullBucketMut<K, V>)
455 -> (K, V, &mut RawTable<K, V>)
457 let (empty, retkey, retval) = starting_bucket.take();
458 let mut gap = match empty.gap_peek() {
460 Err(b) => return (retkey, retval, b.into_table()),
463 while gap.full().displacement() != 0 {
464 gap = match gap.shift() {
467 return (retkey, retval, b.into_table());
472 // Now we've done all our shifting. Return the value we grabbed earlier.
473 (retkey, retval, gap.into_table())
476 /// Perform robin hood bucket stealing at the given `bucket`. You must
477 /// also pass that bucket's displacement so we don't have to recalculate it.
479 /// `hash`, `key`, and `val` are the elements to "robin hood" into the hashtable.
480 fn robin_hood<'a, K: 'a, V: 'a>(bucket: FullBucketMut<'a, K, V>,
481 mut displacement: usize,
485 -> FullBucketMut<'a, K, V> {
486 let size = bucket.table().size();
487 let raw_capacity = bucket.table().capacity();
488 // There can be at most `size - dib` buckets to displace, because
489 // in the worst case, there are `size` elements and we already are
490 // `displacement` buckets away from the initial one.
491 let idx_end = (bucket.index() + size - bucket.displacement()) % raw_capacity;
492 // Save the *starting point*.
493 let mut bucket = bucket.stash();
496 let (old_hash, old_key, old_val) = bucket.replace(hash, key, val);
503 let probe = bucket.next();
504 debug_assert!(probe.index() != idx_end);
506 let full_bucket = match probe.peek() {
509 let bucket = bucket.put(hash, key, val);
510 // Now that it's stolen, just read the value's pointer
511 // right out of the table! Go back to the *starting point*.
513 // This use of `into_table` is misleading. It turns the
514 // bucket, which is a FullBucket on top of a
515 // FullBucketMut, into just one FullBucketMut. The "table"
516 // refers to the inner FullBucketMut in this context.
517 return bucket.into_table();
519 Full(bucket) => bucket,
522 let probe_displacement = full_bucket.displacement();
524 bucket = full_bucket;
526 // Robin hood! Steal the spot.
527 if probe_displacement < displacement {
528 displacement = probe_displacement;
535 impl<K, V, S> HashMap<K, V, S>
539 fn make_hash<X: ?Sized>(&self, x: &X) -> SafeHash
542 table::make_hash(&self.hash_builder, x)
545 /// Search for a key, yielding the index if it's found in the hashtable.
546 /// If you already have the hash for the key lying around, use
549 fn search<'a, Q: ?Sized>(&'a self, q: &Q) -> InternalEntry<K, V, &'a RawTable<K, V>>
553 let hash = self.make_hash(q);
554 search_hashed(&self.table, hash, |k| q.eq(k.borrow()))
558 fn search_mut<'a, Q: ?Sized>(&'a mut self, q: &Q) -> InternalEntry<K, V, &'a mut RawTable<K, V>>
562 let hash = self.make_hash(q);
563 search_hashed(&mut self.table, hash, |k| q.eq(k.borrow()))
566 // The caller should ensure that invariants by Robin Hood Hashing hold
567 // and that there's space in the underlying table.
568 fn insert_hashed_ordered(&mut self, hash: SafeHash, k: K, v: V) {
569 let mut buckets = Bucket::new(&mut self.table, hash);
570 let start_index = buckets.index();
573 // We don't need to compare hashes for value swap.
574 // Not even DIBs for Robin Hood.
575 buckets = match buckets.peek() {
577 empty.put(hash, k, v);
580 Full(b) => b.into_bucket(),
583 debug_assert!(buckets.index() != start_index);
588 impl<K: Hash + Eq, V> HashMap<K, V, RandomState> {
589 /// Creates an empty `HashMap`.
594 /// use std::collections::HashMap;
595 /// let mut map: HashMap<&str, isize> = HashMap::new();
598 #[stable(feature = "rust1", since = "1.0.0")]
599 pub fn new() -> HashMap<K, V, RandomState> {
603 /// Creates an empty `HashMap` with the specified capacity.
605 /// The hash map will be able to hold at least `capacity` elements without
606 /// reallocating. If `capacity` is 0, the hash map will not allocate.
611 /// use std::collections::HashMap;
612 /// let mut map: HashMap<&str, isize> = HashMap::with_capacity(10);
615 #[stable(feature = "rust1", since = "1.0.0")]
616 pub fn with_capacity(capacity: usize) -> HashMap<K, V, RandomState> {
617 HashMap::with_capacity_and_hasher(capacity, Default::default())
621 impl<K, V, S> HashMap<K, V, S>
625 /// Creates an empty `HashMap` which will use the given hash builder to hash
628 /// The created map has the default initial capacity.
630 /// Warning: `hash_builder` is normally randomly generated, and
631 /// is designed to allow HashMaps to be resistant to attacks that
632 /// cause many collisions and very poor performance. Setting it
633 /// manually using this function can expose a DoS attack vector.
638 /// use std::collections::HashMap;
639 /// use std::collections::hash_map::RandomState;
641 /// let s = RandomState::new();
642 /// let mut map = HashMap::with_hasher(s);
643 /// map.insert(1, 2);
646 #[stable(feature = "hashmap_build_hasher", since = "1.7.0")]
647 pub fn with_hasher(hash_builder: S) -> HashMap<K, V, S> {
649 hash_builder: hash_builder,
650 resize_policy: DefaultResizePolicy::new(),
651 table: RawTable::new(0),
655 /// Creates an empty `HashMap` with the specified capacity, using `hash_builder`
656 /// to hash the keys.
658 /// The hash map will be able to hold at least `capacity` elements without
659 /// reallocating. If `capacity` is 0, the hash map will not allocate.
661 /// Warning: `hash_builder` is normally randomly generated, and
662 /// is designed to allow HashMaps to be resistant to attacks that
663 /// cause many collisions and very poor performance. Setting it
664 /// manually using this function can expose a DoS attack vector.
669 /// use std::collections::HashMap;
670 /// use std::collections::hash_map::RandomState;
672 /// let s = RandomState::new();
673 /// let mut map = HashMap::with_capacity_and_hasher(10, s);
674 /// map.insert(1, 2);
677 #[stable(feature = "hashmap_build_hasher", since = "1.7.0")]
678 pub fn with_capacity_and_hasher(capacity: usize, hash_builder: S) -> HashMap<K, V, S> {
679 let resize_policy = DefaultResizePolicy::new();
680 let raw_cap = resize_policy.raw_capacity(capacity);
682 hash_builder: hash_builder,
683 resize_policy: resize_policy,
684 table: RawTable::new(raw_cap),
688 /// Returns a reference to the map's [`BuildHasher`].
690 /// [`BuildHasher`]: ../../std/hash/trait.BuildHasher.html
691 #[stable(feature = "hashmap_public_hasher", since = "1.9.0")]
692 pub fn hasher(&self) -> &S {
696 /// Returns the number of elements the map can hold without reallocating.
698 /// This number is a lower bound; the `HashMap<K, V>` might be able to hold
699 /// more, but is guaranteed to be able to hold at least this many.
704 /// use std::collections::HashMap;
705 /// let map: HashMap<isize, isize> = HashMap::with_capacity(100);
706 /// assert!(map.capacity() >= 100);
709 #[stable(feature = "rust1", since = "1.0.0")]
710 pub fn capacity(&self) -> usize {
711 self.resize_policy.capacity(self.raw_capacity())
714 /// Returns the hash map's raw capacity.
716 fn raw_capacity(&self) -> usize {
717 self.table.capacity()
720 /// Reserves capacity for at least `additional` more elements to be inserted
721 /// in the `HashMap`. The collection may reserve more space to avoid
722 /// frequent reallocations.
726 /// Panics if the new allocation size overflows [`usize`].
728 /// [`usize`]: ../../std/primitive.usize.html
733 /// use std::collections::HashMap;
734 /// let mut map: HashMap<&str, isize> = HashMap::new();
737 #[stable(feature = "rust1", since = "1.0.0")]
738 pub fn reserve(&mut self, additional: usize) {
739 let remaining = self.capacity() - self.len(); // this can't overflow
740 if remaining < additional {
741 let min_cap = self.len().checked_add(additional).expect("reserve overflow");
742 let raw_cap = self.resize_policy.raw_capacity(min_cap);
743 self.resize(raw_cap);
744 } else if self.table.tag() && remaining <= self.len() {
745 // Probe sequence is too long and table is half full,
746 // resize early to reduce probing length.
747 let new_capacity = self.table.capacity() * 2;
748 self.resize(new_capacity);
752 /// Resizes the internal vectors to a new capacity. It's your
753 /// responsibility to:
754 /// 1) Ensure `new_raw_cap` is enough for all the elements, accounting
755 /// for the load factor.
756 /// 2) Ensure `new_raw_cap` is a power of two or zero.
759 fn resize(&mut self, new_raw_cap: usize) {
760 assert!(self.table.size() <= new_raw_cap);
761 assert!(new_raw_cap.is_power_of_two() || new_raw_cap == 0);
763 let mut old_table = replace(&mut self.table, RawTable::new(new_raw_cap));
764 let old_size = old_table.size();
766 if old_table.size() == 0 {
770 let mut bucket = Bucket::head_bucket(&mut old_table);
772 // This is how the buckets might be laid out in memory:
773 // ($ marks an initialized bucket)
775 // |$$$_$$$$$$_$$$$$|
777 // But we've skipped the entire initial cluster of buckets
778 // and will continue iteration in this order:
781 // ^ wrap around once end is reached
784 // ^ exit once table.size == 0
786 bucket = match bucket.peek() {
788 let h = bucket.hash();
789 let (b, k, v) = bucket.take();
790 self.insert_hashed_ordered(h, k, v);
791 if b.table().size() == 0 {
796 Empty(b) => b.into_bucket(),
801 assert_eq!(self.table.size(), old_size);
804 /// Shrinks the capacity of the map as much as possible. It will drop
805 /// down as much as possible while maintaining the internal rules
806 /// and possibly leaving some space in accordance with the resize policy.
811 /// use std::collections::HashMap;
813 /// let mut map: HashMap<isize, isize> = HashMap::with_capacity(100);
814 /// map.insert(1, 2);
815 /// map.insert(3, 4);
816 /// assert!(map.capacity() >= 100);
817 /// map.shrink_to_fit();
818 /// assert!(map.capacity() >= 2);
820 #[stable(feature = "rust1", since = "1.0.0")]
821 pub fn shrink_to_fit(&mut self) {
822 let new_raw_cap = self.resize_policy.raw_capacity(self.len());
823 if self.raw_capacity() != new_raw_cap {
824 let old_table = replace(&mut self.table, RawTable::new(new_raw_cap));
825 let old_size = old_table.size();
827 // Shrink the table. Naive algorithm for resizing:
828 for (h, k, v) in old_table.into_iter() {
829 self.insert_hashed_nocheck(h, k, v);
832 debug_assert_eq!(self.table.size(), old_size);
836 /// Insert a pre-hashed key-value pair, without first checking
837 /// that there's enough room in the buckets. Returns a reference to the
838 /// newly insert value.
840 /// If the key already exists, the hashtable will be returned untouched
841 /// and a reference to the existing element will be returned.
842 fn insert_hashed_nocheck(&mut self, hash: SafeHash, k: K, v: V) -> Option<V> {
843 let entry = search_hashed(&mut self.table, hash, |key| *key == k).into_entry(k);
845 Some(Occupied(mut elem)) => Some(elem.insert(v)),
846 Some(Vacant(elem)) => {
850 None => unreachable!(),
854 /// An iterator visiting all keys in arbitrary order.
855 /// The iterator element type is `&'a K`.
860 /// use std::collections::HashMap;
862 /// let mut map = HashMap::new();
863 /// map.insert("a", 1);
864 /// map.insert("b", 2);
865 /// map.insert("c", 3);
867 /// for key in map.keys() {
868 /// println!("{}", key);
871 #[stable(feature = "rust1", since = "1.0.0")]
872 pub fn keys(&self) -> Keys<K, V> {
873 Keys { inner: self.iter() }
876 /// An iterator visiting all values in arbitrary order.
877 /// The iterator element type is `&'a V`.
882 /// use std::collections::HashMap;
884 /// let mut map = HashMap::new();
885 /// map.insert("a", 1);
886 /// map.insert("b", 2);
887 /// map.insert("c", 3);
889 /// for val in map.values() {
890 /// println!("{}", val);
893 #[stable(feature = "rust1", since = "1.0.0")]
894 pub fn values(&self) -> Values<K, V> {
895 Values { inner: self.iter() }
898 /// An iterator visiting all values mutably in arbitrary order.
899 /// The iterator element type is `&'a mut V`.
904 /// use std::collections::HashMap;
906 /// let mut map = HashMap::new();
908 /// map.insert("a", 1);
909 /// map.insert("b", 2);
910 /// map.insert("c", 3);
912 /// for val in map.values_mut() {
913 /// *val = *val + 10;
916 /// for val in map.values() {
917 /// println!("{}", val);
920 #[stable(feature = "map_values_mut", since = "1.10.0")]
921 pub fn values_mut(&mut self) -> ValuesMut<K, V> {
922 ValuesMut { inner: self.iter_mut() }
925 /// An iterator visiting all key-value pairs in arbitrary order.
926 /// The iterator element type is `(&'a K, &'a V)`.
931 /// use std::collections::HashMap;
933 /// let mut map = HashMap::new();
934 /// map.insert("a", 1);
935 /// map.insert("b", 2);
936 /// map.insert("c", 3);
938 /// for (key, val) in map.iter() {
939 /// println!("key: {} val: {}", key, val);
942 #[stable(feature = "rust1", since = "1.0.0")]
943 pub fn iter(&self) -> Iter<K, V> {
944 Iter { inner: self.table.iter() }
947 /// An iterator visiting all key-value pairs in arbitrary order,
948 /// with mutable references to the values.
949 /// The iterator element type is `(&'a K, &'a mut V)`.
954 /// use std::collections::HashMap;
956 /// let mut map = HashMap::new();
957 /// map.insert("a", 1);
958 /// map.insert("b", 2);
959 /// map.insert("c", 3);
961 /// // Update all values
962 /// for (_, val) in map.iter_mut() {
966 /// for (key, val) in &map {
967 /// println!("key: {} val: {}", key, val);
970 #[stable(feature = "rust1", since = "1.0.0")]
971 pub fn iter_mut(&mut self) -> IterMut<K, V> {
972 IterMut { inner: self.table.iter_mut() }
975 /// Gets the given key's corresponding entry in the map for in-place manipulation.
980 /// use std::collections::HashMap;
982 /// let mut letters = HashMap::new();
984 /// for ch in "a short treatise on fungi".chars() {
985 /// let counter = letters.entry(ch).or_insert(0);
989 /// assert_eq!(letters[&'s'], 2);
990 /// assert_eq!(letters[&'t'], 3);
991 /// assert_eq!(letters[&'u'], 1);
992 /// assert_eq!(letters.get(&'y'), None);
994 #[stable(feature = "rust1", since = "1.0.0")]
995 pub fn entry(&mut self, key: K) -> Entry<K, V> {
998 let hash = self.make_hash(&key);
999 search_hashed(&mut self.table, hash, |q| q.eq(&key))
1000 .into_entry(key).expect("unreachable")
1003 /// Returns the number of elements in the map.
1008 /// use std::collections::HashMap;
1010 /// let mut a = HashMap::new();
1011 /// assert_eq!(a.len(), 0);
1012 /// a.insert(1, "a");
1013 /// assert_eq!(a.len(), 1);
1015 #[stable(feature = "rust1", since = "1.0.0")]
1016 pub fn len(&self) -> usize {
1020 /// Returns true if the map contains no elements.
1025 /// use std::collections::HashMap;
1027 /// let mut a = HashMap::new();
1028 /// assert!(a.is_empty());
1029 /// a.insert(1, "a");
1030 /// assert!(!a.is_empty());
1033 #[stable(feature = "rust1", since = "1.0.0")]
1034 pub fn is_empty(&self) -> bool {
1038 /// Clears the map, returning all key-value pairs as an iterator. Keeps the
1039 /// allocated memory for reuse.
1044 /// use std::collections::HashMap;
1046 /// let mut a = HashMap::new();
1047 /// a.insert(1, "a");
1048 /// a.insert(2, "b");
1050 /// for (k, v) in a.drain().take(1) {
1051 /// assert!(k == 1 || k == 2);
1052 /// assert!(v == "a" || v == "b");
1055 /// assert!(a.is_empty());
1058 #[stable(feature = "drain", since = "1.6.0")]
1059 pub fn drain(&mut self) -> Drain<K, V> {
1060 Drain { inner: self.table.drain() }
1063 /// Clears the map, removing all key-value pairs. Keeps the allocated memory
1069 /// use std::collections::HashMap;
1071 /// let mut a = HashMap::new();
1072 /// a.insert(1, "a");
1074 /// assert!(a.is_empty());
1076 #[stable(feature = "rust1", since = "1.0.0")]
1078 pub fn clear(&mut self) {
1082 /// Returns a reference to the value corresponding to the key.
1084 /// The key may be any borrowed form of the map's key type, but
1085 /// [`Hash`] and [`Eq`] on the borrowed form *must* match those for
1088 /// [`Eq`]: ../../std/cmp/trait.Eq.html
1089 /// [`Hash`]: ../../std/hash/trait.Hash.html
1094 /// use std::collections::HashMap;
1096 /// let mut map = HashMap::new();
1097 /// map.insert(1, "a");
1098 /// assert_eq!(map.get(&1), Some(&"a"));
1099 /// assert_eq!(map.get(&2), None);
1101 #[stable(feature = "rust1", since = "1.0.0")]
1102 pub fn get<Q: ?Sized>(&self, k: &Q) -> Option<&V>
1106 self.search(k).into_occupied_bucket().map(|bucket| bucket.into_refs().1)
1109 /// Returns true if the map contains a value for the specified key.
1111 /// The key may be any borrowed form of the map's key type, but
1112 /// [`Hash`] and [`Eq`] on the borrowed form *must* match those for
1115 /// [`Eq`]: ../../std/cmp/trait.Eq.html
1116 /// [`Hash`]: ../../std/hash/trait.Hash.html
1121 /// use std::collections::HashMap;
1123 /// let mut map = HashMap::new();
1124 /// map.insert(1, "a");
1125 /// assert_eq!(map.contains_key(&1), true);
1126 /// assert_eq!(map.contains_key(&2), false);
1128 #[stable(feature = "rust1", since = "1.0.0")]
1129 pub fn contains_key<Q: ?Sized>(&self, k: &Q) -> bool
1133 self.search(k).into_occupied_bucket().is_some()
1136 /// Returns a mutable reference to the value corresponding to the key.
1138 /// The key may be any borrowed form of the map's key type, but
1139 /// [`Hash`] and [`Eq`] on the borrowed form *must* match those for
1142 /// [`Eq`]: ../../std/cmp/trait.Eq.html
1143 /// [`Hash`]: ../../std/hash/trait.Hash.html
1148 /// use std::collections::HashMap;
1150 /// let mut map = HashMap::new();
1151 /// map.insert(1, "a");
1152 /// if let Some(x) = map.get_mut(&1) {
1155 /// assert_eq!(map[&1], "b");
1157 #[stable(feature = "rust1", since = "1.0.0")]
1158 pub fn get_mut<Q: ?Sized>(&mut self, k: &Q) -> Option<&mut V>
1162 self.search_mut(k).into_occupied_bucket().map(|bucket| bucket.into_mut_refs().1)
1165 /// Inserts a key-value pair into the map.
1167 /// If the map did not have this key present, [`None`] is returned.
1169 /// If the map did have this key present, the value is updated, and the old
1170 /// value is returned. The key is not updated, though; this matters for
1171 /// types that can be `==` without being identical. See the [module-level
1172 /// documentation] for more.
1174 /// [`None`]: ../../std/option/enum.Option.html#variant.None
1175 /// [module-level documentation]: index.html#insert-and-complex-keys
1180 /// use std::collections::HashMap;
1182 /// let mut map = HashMap::new();
1183 /// assert_eq!(map.insert(37, "a"), None);
1184 /// assert_eq!(map.is_empty(), false);
1186 /// map.insert(37, "b");
1187 /// assert_eq!(map.insert(37, "c"), Some("b"));
1188 /// assert_eq!(map[&37], "c");
1190 #[stable(feature = "rust1", since = "1.0.0")]
1191 pub fn insert(&mut self, k: K, v: V) -> Option<V> {
1192 let hash = self.make_hash(&k);
1194 self.insert_hashed_nocheck(hash, k, v)
1197 /// Removes a key from the map, returning the value at the key if the key
1198 /// was previously in the map.
1200 /// The key may be any borrowed form of the map's key type, but
1201 /// [`Hash`] and [`Eq`] on the borrowed form *must* match those for
1204 /// [`Eq`]: ../../std/cmp/trait.Eq.html
1205 /// [`Hash`]: ../../std/hash/trait.Hash.html
1210 /// use std::collections::HashMap;
1212 /// let mut map = HashMap::new();
1213 /// map.insert(1, "a");
1214 /// assert_eq!(map.remove(&1), Some("a"));
1215 /// assert_eq!(map.remove(&1), None);
1217 #[stable(feature = "rust1", since = "1.0.0")]
1218 pub fn remove<Q: ?Sized>(&mut self, k: &Q) -> Option<V>
1222 if self.table.size() == 0 {
1226 self.search_mut(k).into_occupied_bucket().map(|bucket| pop_internal(bucket).1)
1229 /// Retains only the elements specified by the predicate.
1231 /// In other words, remove all pairs `(k, v)` such that `f(&k,&mut v)` returns `false`.
1236 /// use std::collections::HashMap;
1238 /// let mut map: HashMap<isize, isize> = (0..8).map(|x|(x, x*10)).collect();
1239 /// map.retain(|&k, _| k % 2 == 0);
1240 /// assert_eq!(map.len(), 4);
1242 #[stable(feature = "retain_hash_collection", since = "1.18.0")]
1243 pub fn retain<F>(&mut self, mut f: F)
1244 where F: FnMut(&K, &mut V) -> bool
1246 if self.table.size() == 0 {
1249 let mut elems_left = self.table.size();
1250 let mut bucket = Bucket::head_bucket(&mut self.table);
1252 let start_index = bucket.index();
1253 while elems_left != 0 {
1254 bucket = match bucket.peek() {
1257 let should_remove = {
1258 let (k, v) = full.read_mut();
1262 let prev_raw = full.raw();
1263 let (_, _, t) = pop_internal(full);
1264 Bucket::new_from(prev_raw, t)
1273 bucket.prev(); // reverse iteration
1274 debug_assert!(elems_left == 0 || bucket.index() != start_index);
1279 #[stable(feature = "rust1", since = "1.0.0")]
1280 impl<K, V, S> PartialEq for HashMap<K, V, S>
1285 fn eq(&self, other: &HashMap<K, V, S>) -> bool {
1286 if self.len() != other.len() {
1290 self.iter().all(|(key, value)| other.get(key).map_or(false, |v| *value == *v))
1294 #[stable(feature = "rust1", since = "1.0.0")]
1295 impl<K, V, S> Eq for HashMap<K, V, S>
1302 #[stable(feature = "rust1", since = "1.0.0")]
1303 impl<K, V, S> Debug for HashMap<K, V, S>
1304 where K: Eq + Hash + Debug,
1308 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1309 f.debug_map().entries(self.iter()).finish()
1313 #[stable(feature = "rust1", since = "1.0.0")]
1314 impl<K, V, S> Default for HashMap<K, V, S>
1316 S: BuildHasher + Default
1318 /// Creates an empty `HashMap<K, V, S>`, with the `Default` value for the hasher.
1319 fn default() -> HashMap<K, V, S> {
1320 HashMap::with_hasher(Default::default())
1324 #[stable(feature = "rust1", since = "1.0.0")]
1325 impl<'a, K, Q: ?Sized, V, S> Index<&'a Q> for HashMap<K, V, S>
1326 where K: Eq + Hash + Borrow<Q>,
1333 fn index(&self, index: &Q) -> &V {
1334 self.get(index).expect("no entry found for key")
1338 /// An iterator over the entries of a `HashMap`.
1340 /// This `struct` is created by the [`iter`] method on [`HashMap`]. See its
1341 /// documentation for more.
1343 /// [`iter`]: struct.HashMap.html#method.iter
1344 /// [`HashMap`]: struct.HashMap.html
1345 #[stable(feature = "rust1", since = "1.0.0")]
1346 pub struct Iter<'a, K: 'a, V: 'a> {
1347 inner: table::Iter<'a, K, V>,
1350 // FIXME(#19839) Remove in favor of `#[derive(Clone)]`
1351 #[stable(feature = "rust1", since = "1.0.0")]
1352 impl<'a, K, V> Clone for Iter<'a, K, V> {
1353 fn clone(&self) -> Iter<'a, K, V> {
1354 Iter { inner: self.inner.clone() }
1358 #[stable(feature = "std_debug", since = "1.16.0")]
1359 impl<'a, K: Debug, V: Debug> fmt::Debug for Iter<'a, K, V> {
1360 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1362 .entries(self.clone())
1367 /// A mutable iterator over the entries of a `HashMap`.
1369 /// This `struct` is created by the [`iter_mut`] method on [`HashMap`]. See its
1370 /// documentation for more.
1372 /// [`iter_mut`]: struct.HashMap.html#method.iter_mut
1373 /// [`HashMap`]: struct.HashMap.html
1374 #[stable(feature = "rust1", since = "1.0.0")]
1375 pub struct IterMut<'a, K: 'a, V: 'a> {
1376 inner: table::IterMut<'a, K, V>,
1379 /// An owning iterator over the entries of a `HashMap`.
1381 /// This `struct` is created by the [`into_iter`] method on [`HashMap`][`HashMap`]
1382 /// (provided by the `IntoIterator` trait). See its documentation for more.
1384 /// [`into_iter`]: struct.HashMap.html#method.into_iter
1385 /// [`HashMap`]: struct.HashMap.html
1386 #[stable(feature = "rust1", since = "1.0.0")]
1387 pub struct IntoIter<K, V> {
1388 pub(super) inner: table::IntoIter<K, V>,
1391 /// An iterator over the keys of a `HashMap`.
1393 /// This `struct` is created by the [`keys`] method on [`HashMap`]. See its
1394 /// documentation for more.
1396 /// [`keys`]: struct.HashMap.html#method.keys
1397 /// [`HashMap`]: struct.HashMap.html
1398 #[stable(feature = "rust1", since = "1.0.0")]
1399 pub struct Keys<'a, K: 'a, V: 'a> {
1400 inner: Iter<'a, K, V>,
1403 // FIXME(#19839) Remove in favor of `#[derive(Clone)]`
1404 #[stable(feature = "rust1", since = "1.0.0")]
1405 impl<'a, K, V> Clone for Keys<'a, K, V> {
1406 fn clone(&self) -> Keys<'a, K, V> {
1407 Keys { inner: self.inner.clone() }
1411 #[stable(feature = "std_debug", since = "1.16.0")]
1412 impl<'a, K: Debug, V> fmt::Debug for Keys<'a, K, V> {
1413 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1415 .entries(self.clone())
1420 /// An iterator over the values of a `HashMap`.
1422 /// This `struct` is created by the [`values`] method on [`HashMap`]. See its
1423 /// documentation for more.
1425 /// [`values`]: struct.HashMap.html#method.values
1426 /// [`HashMap`]: struct.HashMap.html
1427 #[stable(feature = "rust1", since = "1.0.0")]
1428 pub struct Values<'a, K: 'a, V: 'a> {
1429 inner: Iter<'a, K, V>,
1432 // FIXME(#19839) Remove in favor of `#[derive(Clone)]`
1433 #[stable(feature = "rust1", since = "1.0.0")]
1434 impl<'a, K, V> Clone for Values<'a, K, V> {
1435 fn clone(&self) -> Values<'a, K, V> {
1436 Values { inner: self.inner.clone() }
1440 #[stable(feature = "std_debug", since = "1.16.0")]
1441 impl<'a, K, V: Debug> fmt::Debug for Values<'a, K, V> {
1442 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1444 .entries(self.clone())
1449 /// A draining iterator over the entries of a `HashMap`.
1451 /// This `struct` is created by the [`drain`] method on [`HashMap`]. See its
1452 /// documentation for more.
1454 /// [`drain`]: struct.HashMap.html#method.drain
1455 /// [`HashMap`]: struct.HashMap.html
1456 #[stable(feature = "drain", since = "1.6.0")]
1457 pub struct Drain<'a, K: 'a, V: 'a> {
1458 pub(super) inner: table::Drain<'a, K, V>,
1461 /// A mutable iterator over the values of a `HashMap`.
1463 /// This `struct` is created by the [`values_mut`] method on [`HashMap`]. See its
1464 /// documentation for more.
1466 /// [`values_mut`]: struct.HashMap.html#method.values_mut
1467 /// [`HashMap`]: struct.HashMap.html
1468 #[stable(feature = "map_values_mut", since = "1.10.0")]
1469 pub struct ValuesMut<'a, K: 'a, V: 'a> {
1470 inner: IterMut<'a, K, V>,
1473 enum InternalEntry<K, V, M> {
1474 Occupied { elem: FullBucket<K, V, M> },
1477 elem: VacantEntryState<K, V, M>,
1482 impl<K, V, M> InternalEntry<K, V, M> {
1484 fn into_occupied_bucket(self) -> Option<FullBucket<K, V, M>> {
1486 InternalEntry::Occupied { elem } => Some(elem),
1492 impl<'a, K, V> InternalEntry<K, V, &'a mut RawTable<K, V>> {
1494 fn into_entry(self, key: K) -> Option<Entry<'a, K, V>> {
1496 InternalEntry::Occupied { elem } => {
1497 Some(Occupied(OccupiedEntry {
1502 InternalEntry::Vacant { hash, elem } => {
1503 Some(Vacant(VacantEntry {
1509 InternalEntry::TableIsEmpty => None,
1514 /// A view into a single entry in a map, which may either be vacant or occupied.
1516 /// This `enum` is constructed from the [`entry`] method on [`HashMap`].
1518 /// [`HashMap`]: struct.HashMap.html
1519 /// [`entry`]: struct.HashMap.html#method.entry
1520 #[stable(feature = "rust1", since = "1.0.0")]
1521 pub enum Entry<'a, K: 'a, V: 'a> {
1522 /// An occupied entry.
1523 #[stable(feature = "rust1", since = "1.0.0")]
1524 Occupied(#[stable(feature = "rust1", since = "1.0.0")]
1525 OccupiedEntry<'a, K, V>),
1528 #[stable(feature = "rust1", since = "1.0.0")]
1529 Vacant(#[stable(feature = "rust1", since = "1.0.0")]
1530 VacantEntry<'a, K, V>),
1533 #[stable(feature= "debug_hash_map", since = "1.12.0")]
1534 impl<'a, K: 'a + Debug, V: 'a + Debug> Debug for Entry<'a, K, V> {
1535 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1538 f.debug_tuple("Entry")
1542 Occupied(ref o) => {
1543 f.debug_tuple("Entry")
1551 /// A view into an occupied entry in a `HashMap`.
1552 /// It is part of the [`Entry`] enum.
1554 /// [`Entry`]: enum.Entry.html
1555 #[stable(feature = "rust1", since = "1.0.0")]
1556 pub struct OccupiedEntry<'a, K: 'a, V: 'a> {
1558 elem: FullBucket<K, V, &'a mut RawTable<K, V>>,
1561 #[stable(feature= "debug_hash_map", since = "1.12.0")]
1562 impl<'a, K: 'a + Debug, V: 'a + Debug> Debug for OccupiedEntry<'a, K, V> {
1563 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1564 f.debug_struct("OccupiedEntry")
1565 .field("key", self.key())
1566 .field("value", self.get())
1571 /// A view into a vacant entry in a `HashMap`.
1572 /// It is part of the [`Entry`] enum.
1574 /// [`Entry`]: enum.Entry.html
1575 #[stable(feature = "rust1", since = "1.0.0")]
1576 pub struct VacantEntry<'a, K: 'a, V: 'a> {
1579 elem: VacantEntryState<K, V, &'a mut RawTable<K, V>>,
1582 #[stable(feature= "debug_hash_map", since = "1.12.0")]
1583 impl<'a, K: 'a + Debug, V: 'a> Debug for VacantEntry<'a, K, V> {
1584 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1585 f.debug_tuple("VacantEntry")
1591 /// Possible states of a VacantEntry.
1592 enum VacantEntryState<K, V, M> {
1593 /// The index is occupied, but the key to insert has precedence,
1594 /// and will kick the current one out on insertion.
1595 NeqElem(FullBucket<K, V, M>, usize),
1596 /// The index is genuinely vacant.
1597 NoElem(EmptyBucket<K, V, M>, usize),
1600 #[stable(feature = "rust1", since = "1.0.0")]
1601 impl<'a, K, V, S> IntoIterator for &'a HashMap<K, V, S>
1605 type Item = (&'a K, &'a V);
1606 type IntoIter = Iter<'a, K, V>;
1608 fn into_iter(self) -> Iter<'a, K, V> {
1613 #[stable(feature = "rust1", since = "1.0.0")]
1614 impl<'a, K, V, S> IntoIterator for &'a mut HashMap<K, V, S>
1618 type Item = (&'a K, &'a mut V);
1619 type IntoIter = IterMut<'a, K, V>;
1621 fn into_iter(mut self) -> IterMut<'a, K, V> {
1626 #[stable(feature = "rust1", since = "1.0.0")]
1627 impl<K, V, S> IntoIterator for HashMap<K, V, S>
1632 type IntoIter = IntoIter<K, V>;
1634 /// Creates a consuming iterator, that is, one that moves each key-value
1635 /// pair out of the map in arbitrary order. The map cannot be used after
1641 /// use std::collections::HashMap;
1643 /// let mut map = HashMap::new();
1644 /// map.insert("a", 1);
1645 /// map.insert("b", 2);
1646 /// map.insert("c", 3);
1648 /// // Not possible with .iter()
1649 /// let vec: Vec<(&str, isize)> = map.into_iter().collect();
1651 fn into_iter(self) -> IntoIter<K, V> {
1652 IntoIter { inner: self.table.into_iter() }
1656 #[stable(feature = "rust1", since = "1.0.0")]
1657 impl<'a, K, V> Iterator for Iter<'a, K, V> {
1658 type Item = (&'a K, &'a V);
1661 fn next(&mut self) -> Option<(&'a K, &'a V)> {
1665 fn size_hint(&self) -> (usize, Option<usize>) {
1666 self.inner.size_hint()
1669 #[stable(feature = "rust1", since = "1.0.0")]
1670 impl<'a, K, V> ExactSizeIterator for Iter<'a, K, V> {
1672 fn len(&self) -> usize {
1677 #[unstable(feature = "fused", issue = "35602")]
1678 impl<'a, K, V> FusedIterator for Iter<'a, K, V> {}
1680 #[stable(feature = "rust1", since = "1.0.0")]
1681 impl<'a, K, V> Iterator for IterMut<'a, K, V> {
1682 type Item = (&'a K, &'a mut V);
1685 fn next(&mut self) -> Option<(&'a K, &'a mut V)> {
1689 fn size_hint(&self) -> (usize, Option<usize>) {
1690 self.inner.size_hint()
1693 #[stable(feature = "rust1", since = "1.0.0")]
1694 impl<'a, K, V> ExactSizeIterator for IterMut<'a, K, V> {
1696 fn len(&self) -> usize {
1700 #[unstable(feature = "fused", issue = "35602")]
1701 impl<'a, K, V> FusedIterator for IterMut<'a, K, V> {}
1703 #[stable(feature = "std_debug", since = "1.16.0")]
1704 impl<'a, K, V> fmt::Debug for IterMut<'a, K, V>
1705 where K: fmt::Debug,
1708 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1710 .entries(self.inner.iter())
1715 #[stable(feature = "rust1", since = "1.0.0")]
1716 impl<K, V> Iterator for IntoIter<K, V> {
1720 fn next(&mut self) -> Option<(K, V)> {
1721 self.inner.next().map(|(_, k, v)| (k, v))
1724 fn size_hint(&self) -> (usize, Option<usize>) {
1725 self.inner.size_hint()
1728 #[stable(feature = "rust1", since = "1.0.0")]
1729 impl<K, V> ExactSizeIterator for IntoIter<K, V> {
1731 fn len(&self) -> usize {
1735 #[unstable(feature = "fused", issue = "35602")]
1736 impl<K, V> FusedIterator for IntoIter<K, V> {}
1738 #[stable(feature = "std_debug", since = "1.16.0")]
1739 impl<K: Debug, V: Debug> fmt::Debug for IntoIter<K, V> {
1740 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1742 .entries(self.inner.iter())
1747 #[stable(feature = "rust1", since = "1.0.0")]
1748 impl<'a, K, V> Iterator for Keys<'a, K, V> {
1752 fn next(&mut self) -> Option<(&'a K)> {
1753 self.inner.next().map(|(k, _)| k)
1756 fn size_hint(&self) -> (usize, Option<usize>) {
1757 self.inner.size_hint()
1760 #[stable(feature = "rust1", since = "1.0.0")]
1761 impl<'a, K, V> ExactSizeIterator for Keys<'a, K, V> {
1763 fn len(&self) -> usize {
1767 #[unstable(feature = "fused", issue = "35602")]
1768 impl<'a, K, V> FusedIterator for Keys<'a, K, V> {}
1770 #[stable(feature = "rust1", since = "1.0.0")]
1771 impl<'a, K, V> Iterator for Values<'a, K, V> {
1775 fn next(&mut self) -> Option<(&'a V)> {
1776 self.inner.next().map(|(_, v)| v)
1779 fn size_hint(&self) -> (usize, Option<usize>) {
1780 self.inner.size_hint()
1783 #[stable(feature = "rust1", since = "1.0.0")]
1784 impl<'a, K, V> ExactSizeIterator for Values<'a, K, V> {
1786 fn len(&self) -> usize {
1790 #[unstable(feature = "fused", issue = "35602")]
1791 impl<'a, K, V> FusedIterator for Values<'a, K, V> {}
1793 #[stable(feature = "map_values_mut", since = "1.10.0")]
1794 impl<'a, K, V> Iterator for ValuesMut<'a, K, V> {
1795 type Item = &'a mut V;
1798 fn next(&mut self) -> Option<(&'a mut V)> {
1799 self.inner.next().map(|(_, v)| v)
1802 fn size_hint(&self) -> (usize, Option<usize>) {
1803 self.inner.size_hint()
1806 #[stable(feature = "map_values_mut", since = "1.10.0")]
1807 impl<'a, K, V> ExactSizeIterator for ValuesMut<'a, K, V> {
1809 fn len(&self) -> usize {
1813 #[unstable(feature = "fused", issue = "35602")]
1814 impl<'a, K, V> FusedIterator for ValuesMut<'a, K, V> {}
1816 #[stable(feature = "std_debug", since = "1.16.0")]
1817 impl<'a, K, V> fmt::Debug for ValuesMut<'a, K, V>
1818 where K: fmt::Debug,
1821 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1823 .entries(self.inner.inner.iter())
1828 #[stable(feature = "drain", since = "1.6.0")]
1829 impl<'a, K, V> Iterator for Drain<'a, K, V> {
1833 fn next(&mut self) -> Option<(K, V)> {
1834 self.inner.next().map(|(_, k, v)| (k, v))
1837 fn size_hint(&self) -> (usize, Option<usize>) {
1838 self.inner.size_hint()
1841 #[stable(feature = "drain", since = "1.6.0")]
1842 impl<'a, K, V> ExactSizeIterator for Drain<'a, K, V> {
1844 fn len(&self) -> usize {
1848 #[unstable(feature = "fused", issue = "35602")]
1849 impl<'a, K, V> FusedIterator for Drain<'a, K, V> {}
1851 #[stable(feature = "std_debug", since = "1.16.0")]
1852 impl<'a, K, V> fmt::Debug for Drain<'a, K, V>
1853 where K: fmt::Debug,
1856 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1858 .entries(self.inner.iter())
1863 /// A place for insertion to a `Entry`.
1865 /// See [`HashMap::entry`](struct.HashMap.html#method.entry) for details.
1866 #[must_use = "places do nothing unless written to with `<-` syntax"]
1867 #[unstable(feature = "collection_placement",
1868 reason = "struct name and placement protocol is subject to change",
1870 pub struct EntryPlace<'a, K: 'a, V: 'a> {
1871 bucket: FullBucketMut<'a, K, V>,
1874 #[unstable(feature = "collection_placement",
1875 reason = "struct name and placement protocol is subject to change",
1877 impl<'a, K: 'a + Debug, V: 'a + Debug> Debug for EntryPlace<'a, K, V> {
1878 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1879 f.debug_struct("EntryPlace")
1880 .field("key", self.bucket.read().0)
1881 .field("value", self.bucket.read().1)
1886 #[unstable(feature = "collection_placement",
1887 reason = "struct name and placement protocol is subject to change",
1889 impl<'a, K, V> Drop for EntryPlace<'a, K, V> {
1890 fn drop(&mut self) {
1891 // Inplacement insertion failed. Only key need to drop.
1892 // The value is failed to insert into map.
1893 unsafe { self.bucket.remove_key() };
1897 #[unstable(feature = "collection_placement",
1898 reason = "placement protocol is subject to change",
1900 impl<'a, K, V> Placer<V> for Entry<'a, K, V> {
1901 type Place = EntryPlace<'a, K, V>;
1903 fn make_place(self) -> EntryPlace<'a, K, V> {
1904 let b = match self {
1905 Occupied(mut o) => {
1906 unsafe { ptr::drop_in_place(o.elem.read_mut().1); }
1910 unsafe { v.insert_key() }
1913 EntryPlace { bucket: b }
1917 #[unstable(feature = "collection_placement",
1918 reason = "placement protocol is subject to change",
1920 impl<'a, K, V> Place<V> for EntryPlace<'a, K, V> {
1921 fn pointer(&mut self) -> *mut V {
1922 self.bucket.read_mut().1
1926 #[unstable(feature = "collection_placement",
1927 reason = "placement protocol is subject to change",
1929 impl<'a, K, V> InPlace<V> for EntryPlace<'a, K, V> {
1932 unsafe fn finalize(self) {
1937 impl<'a, K, V> Entry<'a, K, V> {
1938 #[stable(feature = "rust1", since = "1.0.0")]
1939 /// Ensures a value is in the entry by inserting the default if empty, and returns
1940 /// a mutable reference to the value in the entry.
1945 /// use std::collections::HashMap;
1947 /// let mut map: HashMap<&str, u32> = HashMap::new();
1948 /// map.entry("poneyland").or_insert(12);
1950 /// assert_eq!(map["poneyland"], 12);
1952 /// *map.entry("poneyland").or_insert(12) += 10;
1953 /// assert_eq!(map["poneyland"], 22);
1955 pub fn or_insert(self, default: V) -> &'a mut V {
1957 Occupied(entry) => entry.into_mut(),
1958 Vacant(entry) => entry.insert(default),
1962 #[stable(feature = "rust1", since = "1.0.0")]
1963 /// Ensures a value is in the entry by inserting the result of the default function if empty,
1964 /// and returns a mutable reference to the value in the entry.
1969 /// use std::collections::HashMap;
1971 /// let mut map: HashMap<&str, String> = HashMap::new();
1972 /// let s = "hoho".to_string();
1974 /// map.entry("poneyland").or_insert_with(|| s);
1976 /// assert_eq!(map["poneyland"], "hoho".to_string());
1978 pub fn or_insert_with<F: FnOnce() -> V>(self, default: F) -> &'a mut V {
1980 Occupied(entry) => entry.into_mut(),
1981 Vacant(entry) => entry.insert(default()),
1985 /// Returns a reference to this entry's key.
1990 /// use std::collections::HashMap;
1992 /// let mut map: HashMap<&str, u32> = HashMap::new();
1993 /// assert_eq!(map.entry("poneyland").key(), &"poneyland");
1995 #[stable(feature = "map_entry_keys", since = "1.10.0")]
1996 pub fn key(&self) -> &K {
1998 Occupied(ref entry) => entry.key(),
1999 Vacant(ref entry) => entry.key(),
2004 impl<'a, K, V> OccupiedEntry<'a, K, V> {
2005 /// Gets a reference to the key in the entry.
2010 /// use std::collections::HashMap;
2012 /// let mut map: HashMap<&str, u32> = HashMap::new();
2013 /// map.entry("poneyland").or_insert(12);
2014 /// assert_eq!(map.entry("poneyland").key(), &"poneyland");
2016 #[stable(feature = "map_entry_keys", since = "1.10.0")]
2017 pub fn key(&self) -> &K {
2021 /// Take the ownership of the key and value from the map.
2026 /// use std::collections::HashMap;
2027 /// use std::collections::hash_map::Entry;
2029 /// let mut map: HashMap<&str, u32> = HashMap::new();
2030 /// map.entry("poneyland").or_insert(12);
2032 /// if let Entry::Occupied(o) = map.entry("poneyland") {
2033 /// // We delete the entry from the map.
2034 /// o.remove_entry();
2037 /// assert_eq!(map.contains_key("poneyland"), false);
2039 #[stable(feature = "map_entry_recover_keys2", since = "1.12.0")]
2040 pub fn remove_entry(self) -> (K, V) {
2041 let (k, v, _) = pop_internal(self.elem);
2045 /// Gets a reference to the value in the entry.
2050 /// use std::collections::HashMap;
2051 /// use std::collections::hash_map::Entry;
2053 /// let mut map: HashMap<&str, u32> = HashMap::new();
2054 /// map.entry("poneyland").or_insert(12);
2056 /// if let Entry::Occupied(o) = map.entry("poneyland") {
2057 /// assert_eq!(o.get(), &12);
2060 #[stable(feature = "rust1", since = "1.0.0")]
2061 pub fn get(&self) -> &V {
2065 /// Gets a mutable reference to the value in the entry.
2070 /// use std::collections::HashMap;
2071 /// use std::collections::hash_map::Entry;
2073 /// let mut map: HashMap<&str, u32> = HashMap::new();
2074 /// map.entry("poneyland").or_insert(12);
2076 /// assert_eq!(map["poneyland"], 12);
2077 /// if let Entry::Occupied(mut o) = map.entry("poneyland") {
2078 /// *o.get_mut() += 10;
2081 /// assert_eq!(map["poneyland"], 22);
2083 #[stable(feature = "rust1", since = "1.0.0")]
2084 pub fn get_mut(&mut self) -> &mut V {
2085 self.elem.read_mut().1
2088 /// Converts the OccupiedEntry into a mutable reference to the value in the entry
2089 /// with a lifetime bound to the map itself.
2094 /// use std::collections::HashMap;
2095 /// use std::collections::hash_map::Entry;
2097 /// let mut map: HashMap<&str, u32> = HashMap::new();
2098 /// map.entry("poneyland").or_insert(12);
2100 /// assert_eq!(map["poneyland"], 12);
2101 /// if let Entry::Occupied(o) = map.entry("poneyland") {
2102 /// *o.into_mut() += 10;
2105 /// assert_eq!(map["poneyland"], 22);
2107 #[stable(feature = "rust1", since = "1.0.0")]
2108 pub fn into_mut(self) -> &'a mut V {
2109 self.elem.into_mut_refs().1
2112 /// Sets the value of the entry, and returns the entry's old value.
2117 /// use std::collections::HashMap;
2118 /// use std::collections::hash_map::Entry;
2120 /// let mut map: HashMap<&str, u32> = HashMap::new();
2121 /// map.entry("poneyland").or_insert(12);
2123 /// if let Entry::Occupied(mut o) = map.entry("poneyland") {
2124 /// assert_eq!(o.insert(15), 12);
2127 /// assert_eq!(map["poneyland"], 15);
2129 #[stable(feature = "rust1", since = "1.0.0")]
2130 pub fn insert(&mut self, mut value: V) -> V {
2131 let old_value = self.get_mut();
2132 mem::swap(&mut value, old_value);
2136 /// Takes the value out of the entry, and returns it.
2141 /// use std::collections::HashMap;
2142 /// use std::collections::hash_map::Entry;
2144 /// let mut map: HashMap<&str, u32> = HashMap::new();
2145 /// map.entry("poneyland").or_insert(12);
2147 /// if let Entry::Occupied(o) = map.entry("poneyland") {
2148 /// assert_eq!(o.remove(), 12);
2151 /// assert_eq!(map.contains_key("poneyland"), false);
2153 #[stable(feature = "rust1", since = "1.0.0")]
2154 pub fn remove(self) -> V {
2155 pop_internal(self.elem).1
2158 /// Returns a key that was used for search.
2160 /// The key was retained for further use.
2161 fn take_key(&mut self) -> Option<K> {
2166 impl<'a, K: 'a, V: 'a> VacantEntry<'a, K, V> {
2167 /// Gets a reference to the key that would be used when inserting a value
2168 /// through the `VacantEntry`.
2173 /// use std::collections::HashMap;
2175 /// let mut map: HashMap<&str, u32> = HashMap::new();
2176 /// assert_eq!(map.entry("poneyland").key(), &"poneyland");
2178 #[stable(feature = "map_entry_keys", since = "1.10.0")]
2179 pub fn key(&self) -> &K {
2183 /// Take ownership of the key.
2188 /// use std::collections::HashMap;
2189 /// use std::collections::hash_map::Entry;
2191 /// let mut map: HashMap<&str, u32> = HashMap::new();
2193 /// if let Entry::Vacant(v) = map.entry("poneyland") {
2197 #[stable(feature = "map_entry_recover_keys2", since = "1.12.0")]
2198 pub fn into_key(self) -> K {
2202 /// Sets the value of the entry with the VacantEntry's key,
2203 /// and returns a mutable reference to it.
2208 /// use std::collections::HashMap;
2209 /// use std::collections::hash_map::Entry;
2211 /// let mut map: HashMap<&str, u32> = HashMap::new();
2213 /// if let Entry::Vacant(o) = map.entry("poneyland") {
2216 /// assert_eq!(map["poneyland"], 37);
2218 #[stable(feature = "rust1", since = "1.0.0")]
2219 pub fn insert(self, value: V) -> &'a mut V {
2220 let b = match self.elem {
2221 NeqElem(mut bucket, disp) => {
2222 if disp >= DISPLACEMENT_THRESHOLD {
2223 bucket.table_mut().set_tag(true);
2225 robin_hood(bucket, disp, self.hash, self.key, value)
2227 NoElem(mut bucket, disp) => {
2228 if disp >= DISPLACEMENT_THRESHOLD {
2229 bucket.table_mut().set_tag(true);
2231 bucket.put(self.hash, self.key, value)
2237 // Only used for InPlacement insert. Avoid unnecessary value copy.
2238 // The value remains uninitialized.
2239 unsafe fn insert_key(self) -> FullBucketMut<'a, K, V> {
2241 NeqElem(mut bucket, disp) => {
2242 if disp >= DISPLACEMENT_THRESHOLD {
2243 bucket.table_mut().set_tag(true);
2245 let uninit = mem::uninitialized();
2246 robin_hood(bucket, disp, self.hash, self.key, uninit)
2248 NoElem(mut bucket, disp) => {
2249 if disp >= DISPLACEMENT_THRESHOLD {
2250 bucket.table_mut().set_tag(true);
2252 bucket.put_key(self.hash, self.key)
2258 #[stable(feature = "rust1", since = "1.0.0")]
2259 impl<K, V, S> FromIterator<(K, V)> for HashMap<K, V, S>
2261 S: BuildHasher + Default
2263 fn from_iter<T: IntoIterator<Item = (K, V)>>(iter: T) -> HashMap<K, V, S> {
2264 let mut map = HashMap::with_hasher(Default::default());
2270 #[stable(feature = "rust1", since = "1.0.0")]
2271 impl<K, V, S> Extend<(K, V)> for HashMap<K, V, S>
2275 fn extend<T: IntoIterator<Item = (K, V)>>(&mut self, iter: T) {
2276 // Keys may be already present or show multiple times in the iterator.
2277 // Reserve the entire hint lower bound if the map is empty.
2278 // Otherwise reserve half the hint (rounded up), so the map
2279 // will only resize twice in the worst case.
2280 let iter = iter.into_iter();
2281 let reserve = if self.is_empty() {
2284 (iter.size_hint().0 + 1) / 2
2286 self.reserve(reserve);
2287 for (k, v) in iter {
2293 #[stable(feature = "hash_extend_copy", since = "1.4.0")]
2294 impl<'a, K, V, S> Extend<(&'a K, &'a V)> for HashMap<K, V, S>
2295 where K: Eq + Hash + Copy,
2299 fn extend<T: IntoIterator<Item = (&'a K, &'a V)>>(&mut self, iter: T) {
2300 self.extend(iter.into_iter().map(|(&key, &value)| (key, value)));
2304 /// `RandomState` is the default state for [`HashMap`] types.
2306 /// A particular instance `RandomState` will create the same instances of
2307 /// [`Hasher`], but the hashers created by two different `RandomState`
2308 /// instances are unlikely to produce the same result for the same values.
2310 /// [`HashMap`]: struct.HashMap.html
2311 /// [`Hasher`]: ../../hash/trait.Hasher.html
2316 /// use std::collections::HashMap;
2317 /// use std::collections::hash_map::RandomState;
2319 /// let s = RandomState::new();
2320 /// let mut map = HashMap::with_hasher(s);
2321 /// map.insert(1, 2);
2324 #[stable(feature = "hashmap_build_hasher", since = "1.7.0")]
2325 pub struct RandomState {
2331 /// Constructs a new `RandomState` that is initialized with random keys.
2336 /// use std::collections::hash_map::RandomState;
2338 /// let s = RandomState::new();
2341 #[allow(deprecated)]
2343 #[stable(feature = "hashmap_build_hasher", since = "1.7.0")]
2344 pub fn new() -> RandomState {
2345 // Historically this function did not cache keys from the OS and instead
2346 // simply always called `rand::thread_rng().gen()` twice. In #31356 it
2347 // was discovered, however, that because we re-seed the thread-local RNG
2348 // from the OS periodically that this can cause excessive slowdown when
2349 // many hash maps are created on a thread. To solve this performance
2350 // trap we cache the first set of randomly generated keys per-thread.
2352 // Later in #36481 it was discovered that exposing a deterministic
2353 // iteration order allows a form of DOS attack. To counter that we
2354 // increment one of the seeds on every RandomState creation, giving
2355 // every corresponding HashMap a different iteration order.
2356 thread_local!(static KEYS: Cell<(u64, u64)> = {
2357 let r = rand::OsRng::new();
2358 let mut r = r.expect("failed to create an OS RNG");
2359 Cell::new((r.gen(), r.gen()))
2363 let (k0, k1) = keys.get();
2364 keys.set((k0.wrapping_add(1), k1));
2365 RandomState { k0: k0, k1: k1 }
2370 #[stable(feature = "hashmap_build_hasher", since = "1.7.0")]
2371 impl BuildHasher for RandomState {
2372 type Hasher = DefaultHasher;
2374 #[allow(deprecated)]
2375 fn build_hasher(&self) -> DefaultHasher {
2376 DefaultHasher(SipHasher13::new_with_keys(self.k0, self.k1))
2380 /// The default [`Hasher`] used by [`RandomState`].
2382 /// The internal algorithm is not specified, and so it and its hashes should
2383 /// not be relied upon over releases.
2385 /// [`RandomState`]: struct.RandomState.html
2386 /// [`Hasher`]: ../../hash/trait.Hasher.html
2387 #[stable(feature = "hashmap_default_hasher", since = "1.13.0")]
2388 #[allow(deprecated)]
2389 #[derive(Clone, Debug)]
2390 pub struct DefaultHasher(SipHasher13);
2392 impl DefaultHasher {
2393 /// Creates a new `DefaultHasher`.
2395 /// This hasher is not guaranteed to be the same as all other
2396 /// `DefaultHasher` instances, but is the same as all other `DefaultHasher`
2397 /// instances created through `new` or `default`.
2398 #[stable(feature = "hashmap_default_hasher", since = "1.13.0")]
2399 #[allow(deprecated)]
2400 pub fn new() -> DefaultHasher {
2401 DefaultHasher(SipHasher13::new_with_keys(0, 0))
2405 #[stable(feature = "hashmap_default_hasher", since = "1.13.0")]
2406 impl Default for DefaultHasher {
2407 /// Creates a new `DefaultHasher` using [`new`]. See its documentation for more.
2409 /// [`new`]: #method.new
2410 fn default() -> DefaultHasher {
2411 DefaultHasher::new()
2415 #[stable(feature = "hashmap_default_hasher", since = "1.13.0")]
2416 impl Hasher for DefaultHasher {
2418 fn write(&mut self, msg: &[u8]) {
2423 fn finish(&self) -> u64 {
2428 #[stable(feature = "hashmap_build_hasher", since = "1.7.0")]
2429 impl Default for RandomState {
2430 /// Constructs a new `RandomState`.
2432 fn default() -> RandomState {
2437 #[stable(feature = "std_debug", since = "1.16.0")]
2438 impl fmt::Debug for RandomState {
2439 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
2440 f.pad("RandomState { .. }")
2444 impl<K, S, Q: ?Sized> super::Recover<Q> for HashMap<K, (), S>
2445 where K: Eq + Hash + Borrow<Q>,
2451 fn get(&self, key: &Q) -> Option<&K> {
2452 self.search(key).into_occupied_bucket().map(|bucket| bucket.into_refs().0)
2455 fn take(&mut self, key: &Q) -> Option<K> {
2456 if self.table.size() == 0 {
2460 self.search_mut(key).into_occupied_bucket().map(|bucket| pop_internal(bucket).0)
2463 fn replace(&mut self, key: K) -> Option<K> {
2466 match self.entry(key) {
2467 Occupied(mut occupied) => {
2468 let key = occupied.take_key().unwrap();
2469 Some(mem::replace(occupied.elem.read_mut().0, key))
2480 fn assert_covariance() {
2481 fn map_key<'new>(v: HashMap<&'static str, u8>) -> HashMap<&'new str, u8> {
2484 fn map_val<'new>(v: HashMap<u8, &'static str>) -> HashMap<u8, &'new str> {
2487 fn iter_key<'a, 'new>(v: Iter<'a, &'static str, u8>) -> Iter<'a, &'new str, u8> {
2490 fn iter_val<'a, 'new>(v: Iter<'a, u8, &'static str>) -> Iter<'a, u8, &'new str> {
2493 fn into_iter_key<'new>(v: IntoIter<&'static str, u8>) -> IntoIter<&'new str, u8> {
2496 fn into_iter_val<'new>(v: IntoIter<u8, &'static str>) -> IntoIter<u8, &'new str> {
2499 fn keys_key<'a, 'new>(v: Keys<'a, &'static str, u8>) -> Keys<'a, &'new str, u8> {
2502 fn keys_val<'a, 'new>(v: Keys<'a, u8, &'static str>) -> Keys<'a, u8, &'new str> {
2505 fn values_key<'a, 'new>(v: Values<'a, &'static str, u8>) -> Values<'a, &'new str, u8> {
2508 fn values_val<'a, 'new>(v: Values<'a, u8, &'static str>) -> Values<'a, u8, &'new str> {
2511 fn drain<'new>(d: Drain<'static, &'static str, &'static str>)
2512 -> Drain<'new, &'new str, &'new str> {
2520 use super::Entry::{Occupied, Vacant};
2521 use super::RandomState;
2523 use rand::{thread_rng, Rng};
2527 fn test_zero_capacities() {
2528 type HM = HashMap<i32, i32>;
2531 assert_eq!(m.capacity(), 0);
2533 let m = HM::default();
2534 assert_eq!(m.capacity(), 0);
2536 let m = HM::with_hasher(RandomState::new());
2537 assert_eq!(m.capacity(), 0);
2539 let m = HM::with_capacity(0);
2540 assert_eq!(m.capacity(), 0);
2542 let m = HM::with_capacity_and_hasher(0, RandomState::new());
2543 assert_eq!(m.capacity(), 0);
2545 let mut m = HM::new();
2551 assert_eq!(m.capacity(), 0);
2553 let mut m = HM::new();
2555 assert_eq!(m.capacity(), 0);
2559 fn test_create_capacity_zero() {
2560 let mut m = HashMap::with_capacity(0);
2562 assert!(m.insert(1, 1).is_none());
2564 assert!(m.contains_key(&1));
2565 assert!(!m.contains_key(&0));
2570 let mut m = HashMap::new();
2571 assert_eq!(m.len(), 0);
2572 assert!(m.insert(1, 2).is_none());
2573 assert_eq!(m.len(), 1);
2574 assert!(m.insert(2, 4).is_none());
2575 assert_eq!(m.len(), 2);
2576 assert_eq!(*m.get(&1).unwrap(), 2);
2577 assert_eq!(*m.get(&2).unwrap(), 4);
2582 let mut m = HashMap::new();
2583 assert_eq!(m.len(), 0);
2584 assert!(m.insert(1, 2).is_none());
2585 assert_eq!(m.len(), 1);
2586 assert!(m.insert(2, 4).is_none());
2587 assert_eq!(m.len(), 2);
2589 assert_eq!(*m2.get(&1).unwrap(), 2);
2590 assert_eq!(*m2.get(&2).unwrap(), 4);
2591 assert_eq!(m2.len(), 2);
2594 thread_local! { static DROP_VECTOR: RefCell<Vec<isize>> = RefCell::new(Vec::new()) }
2596 #[derive(Hash, PartialEq, Eq)]
2602 fn new(k: usize) -> Dropable {
2603 DROP_VECTOR.with(|slot| {
2604 slot.borrow_mut()[k] += 1;
2611 impl Drop for Dropable {
2612 fn drop(&mut self) {
2613 DROP_VECTOR.with(|slot| {
2614 slot.borrow_mut()[self.k] -= 1;
2619 impl Clone for Dropable {
2620 fn clone(&self) -> Dropable {
2621 Dropable::new(self.k)
2627 DROP_VECTOR.with(|slot| {
2628 *slot.borrow_mut() = vec![0; 200];
2632 let mut m = HashMap::new();
2634 DROP_VECTOR.with(|v| {
2636 assert_eq!(v.borrow()[i], 0);
2641 let d1 = Dropable::new(i);
2642 let d2 = Dropable::new(i + 100);
2646 DROP_VECTOR.with(|v| {
2648 assert_eq!(v.borrow()[i], 1);
2653 let k = Dropable::new(i);
2654 let v = m.remove(&k);
2656 assert!(v.is_some());
2658 DROP_VECTOR.with(|v| {
2659 assert_eq!(v.borrow()[i], 1);
2660 assert_eq!(v.borrow()[i+100], 1);
2664 DROP_VECTOR.with(|v| {
2666 assert_eq!(v.borrow()[i], 0);
2667 assert_eq!(v.borrow()[i+100], 0);
2671 assert_eq!(v.borrow()[i], 1);
2672 assert_eq!(v.borrow()[i+100], 1);
2677 DROP_VECTOR.with(|v| {
2679 assert_eq!(v.borrow()[i], 0);
2685 fn test_into_iter_drops() {
2686 DROP_VECTOR.with(|v| {
2687 *v.borrow_mut() = vec![0; 200];
2691 let mut hm = HashMap::new();
2693 DROP_VECTOR.with(|v| {
2695 assert_eq!(v.borrow()[i], 0);
2700 let d1 = Dropable::new(i);
2701 let d2 = Dropable::new(i + 100);
2705 DROP_VECTOR.with(|v| {
2707 assert_eq!(v.borrow()[i], 1);
2714 // By the way, ensure that cloning doesn't screw up the dropping.
2718 let mut half = hm.into_iter().take(50);
2720 DROP_VECTOR.with(|v| {
2722 assert_eq!(v.borrow()[i], 1);
2726 for _ in half.by_ref() {}
2728 DROP_VECTOR.with(|v| {
2730 .filter(|&i| v.borrow()[i] == 1)
2734 .filter(|&i| v.borrow()[i + 100] == 1)
2742 DROP_VECTOR.with(|v| {
2744 assert_eq!(v.borrow()[i], 0);
2750 fn test_empty_remove() {
2751 let mut m: HashMap<isize, bool> = HashMap::new();
2752 assert_eq!(m.remove(&0), None);
2756 fn test_empty_entry() {
2757 let mut m: HashMap<isize, bool> = HashMap::new();
2759 Occupied(_) => panic!(),
2762 assert!(*m.entry(0).or_insert(true));
2763 assert_eq!(m.len(), 1);
2767 fn test_empty_iter() {
2768 let mut m: HashMap<isize, bool> = HashMap::new();
2769 assert_eq!(m.drain().next(), None);
2770 assert_eq!(m.keys().next(), None);
2771 assert_eq!(m.values().next(), None);
2772 assert_eq!(m.values_mut().next(), None);
2773 assert_eq!(m.iter().next(), None);
2774 assert_eq!(m.iter_mut().next(), None);
2775 assert_eq!(m.len(), 0);
2776 assert!(m.is_empty());
2777 assert_eq!(m.into_iter().next(), None);
2781 fn test_lots_of_insertions() {
2782 let mut m = HashMap::new();
2784 // Try this a few times to make sure we never screw up the hashmap's
2787 assert!(m.is_empty());
2790 assert!(m.insert(i, i).is_none());
2794 assert_eq!(r, Some(&j));
2797 for j in i + 1..1001 {
2799 assert_eq!(r, None);
2803 for i in 1001..2001 {
2804 assert!(!m.contains_key(&i));
2809 assert!(m.remove(&i).is_some());
2812 assert!(!m.contains_key(&j));
2815 for j in i + 1..1001 {
2816 assert!(m.contains_key(&j));
2821 assert!(!m.contains_key(&i));
2825 assert!(m.insert(i, i).is_none());
2829 for i in (1..1001).rev() {
2830 assert!(m.remove(&i).is_some());
2833 assert!(!m.contains_key(&j));
2837 assert!(m.contains_key(&j));
2844 fn test_find_mut() {
2845 let mut m = HashMap::new();
2846 assert!(m.insert(1, 12).is_none());
2847 assert!(m.insert(2, 8).is_none());
2848 assert!(m.insert(5, 14).is_none());
2850 match m.get_mut(&5) {
2852 Some(x) => *x = new,
2854 assert_eq!(m.get(&5), Some(&new));
2858 fn test_insert_overwrite() {
2859 let mut m = HashMap::new();
2860 assert!(m.insert(1, 2).is_none());
2861 assert_eq!(*m.get(&1).unwrap(), 2);
2862 assert!(!m.insert(1, 3).is_none());
2863 assert_eq!(*m.get(&1).unwrap(), 3);
2867 fn test_insert_conflicts() {
2868 let mut m = HashMap::with_capacity(4);
2869 assert!(m.insert(1, 2).is_none());
2870 assert!(m.insert(5, 3).is_none());
2871 assert!(m.insert(9, 4).is_none());
2872 assert_eq!(*m.get(&9).unwrap(), 4);
2873 assert_eq!(*m.get(&5).unwrap(), 3);
2874 assert_eq!(*m.get(&1).unwrap(), 2);
2878 fn test_conflict_remove() {
2879 let mut m = HashMap::with_capacity(4);
2880 assert!(m.insert(1, 2).is_none());
2881 assert_eq!(*m.get(&1).unwrap(), 2);
2882 assert!(m.insert(5, 3).is_none());
2883 assert_eq!(*m.get(&1).unwrap(), 2);
2884 assert_eq!(*m.get(&5).unwrap(), 3);
2885 assert!(m.insert(9, 4).is_none());
2886 assert_eq!(*m.get(&1).unwrap(), 2);
2887 assert_eq!(*m.get(&5).unwrap(), 3);
2888 assert_eq!(*m.get(&9).unwrap(), 4);
2889 assert!(m.remove(&1).is_some());
2890 assert_eq!(*m.get(&9).unwrap(), 4);
2891 assert_eq!(*m.get(&5).unwrap(), 3);
2895 fn test_is_empty() {
2896 let mut m = HashMap::with_capacity(4);
2897 assert!(m.insert(1, 2).is_none());
2898 assert!(!m.is_empty());
2899 assert!(m.remove(&1).is_some());
2900 assert!(m.is_empty());
2905 let mut m = HashMap::new();
2907 assert_eq!(m.remove(&1), Some(2));
2908 assert_eq!(m.remove(&1), None);
2913 let mut m = HashMap::with_capacity(4);
2915 assert!(m.insert(i, i*2).is_none());
2917 assert_eq!(m.len(), 32);
2919 let mut observed: u32 = 0;
2922 assert_eq!(*v, *k * 2);
2923 observed |= 1 << *k;
2925 assert_eq!(observed, 0xFFFF_FFFF);
2930 let vec = vec![(1, 'a'), (2, 'b'), (3, 'c')];
2931 let map: HashMap<_, _> = vec.into_iter().collect();
2932 let keys: Vec<_> = map.keys().cloned().collect();
2933 assert_eq!(keys.len(), 3);
2934 assert!(keys.contains(&1));
2935 assert!(keys.contains(&2));
2936 assert!(keys.contains(&3));
2941 let vec = vec![(1, 'a'), (2, 'b'), (3, 'c')];
2942 let map: HashMap<_, _> = vec.into_iter().collect();
2943 let values: Vec<_> = map.values().cloned().collect();
2944 assert_eq!(values.len(), 3);
2945 assert!(values.contains(&'a'));
2946 assert!(values.contains(&'b'));
2947 assert!(values.contains(&'c'));
2951 fn test_values_mut() {
2952 let vec = vec![(1, 1), (2, 2), (3, 3)];
2953 let mut map: HashMap<_, _> = vec.into_iter().collect();
2954 for value in map.values_mut() {
2955 *value = (*value) * 2
2957 let values: Vec<_> = map.values().cloned().collect();
2958 assert_eq!(values.len(), 3);
2959 assert!(values.contains(&2));
2960 assert!(values.contains(&4));
2961 assert!(values.contains(&6));
2966 let mut m = HashMap::new();
2967 assert!(m.get(&1).is_none());
2971 Some(v) => assert_eq!(*v, 2),
2977 let mut m1 = HashMap::new();
2982 let mut m2 = HashMap::new();
2995 let mut map = HashMap::new();
2996 let empty: HashMap<i32, i32> = HashMap::new();
3001 let map_str = format!("{:?}", map);
3003 assert!(map_str == "{1: 2, 3: 4}" ||
3004 map_str == "{3: 4, 1: 2}");
3005 assert_eq!(format!("{:?}", empty), "{}");
3010 let mut m = HashMap::new();
3012 assert_eq!(m.len(), 0);
3013 assert!(m.is_empty());
3016 let old_raw_cap = m.raw_capacity();
3017 while old_raw_cap == m.raw_capacity() {
3022 assert_eq!(m.len(), i);
3023 assert!(!m.is_empty());
3027 fn test_behavior_resize_policy() {
3028 let mut m = HashMap::new();
3030 assert_eq!(m.len(), 0);
3031 assert_eq!(m.raw_capacity(), 0);
3032 assert!(m.is_empty());
3036 assert!(m.is_empty());
3037 let initial_raw_cap = m.raw_capacity();
3038 m.reserve(initial_raw_cap);
3039 let raw_cap = m.raw_capacity();
3041 assert_eq!(raw_cap, initial_raw_cap * 2);
3044 for _ in 0..raw_cap * 3 / 4 {
3048 // three quarters full
3050 assert_eq!(m.len(), i);
3051 assert_eq!(m.raw_capacity(), raw_cap);
3053 for _ in 0..raw_cap / 4 {
3059 let new_raw_cap = m.raw_capacity();
3060 assert_eq!(new_raw_cap, raw_cap * 2);
3062 for _ in 0..raw_cap / 2 - 1 {
3065 assert_eq!(m.raw_capacity(), new_raw_cap);
3067 // A little more than one quarter full.
3069 assert_eq!(m.raw_capacity(), raw_cap);
3070 // again, a little more than half full
3071 for _ in 0..raw_cap / 2 - 1 {
3077 assert_eq!(m.len(), i);
3078 assert!(!m.is_empty());
3079 assert_eq!(m.raw_capacity(), initial_raw_cap);
3083 fn test_reserve_shrink_to_fit() {
3084 let mut m = HashMap::new();
3087 assert!(m.capacity() >= m.len());
3093 let usable_cap = m.capacity();
3094 for i in 128..(128 + 256) {
3096 assert_eq!(m.capacity(), usable_cap);
3099 for i in 100..(128 + 256) {
3100 assert_eq!(m.remove(&i), Some(i));
3104 assert_eq!(m.len(), 100);
3105 assert!(!m.is_empty());
3106 assert!(m.capacity() >= m.len());
3109 assert_eq!(m.remove(&i), Some(i));
3114 assert_eq!(m.len(), 1);
3115 assert!(m.capacity() >= m.len());
3116 assert_eq!(m.remove(&0), Some(0));
3120 fn test_from_iter() {
3121 let xs = [(1, 1), (2, 2), (3, 3), (4, 4), (5, 5), (6, 6)];
3123 let map: HashMap<_, _> = xs.iter().cloned().collect();
3125 for &(k, v) in &xs {
3126 assert_eq!(map.get(&k), Some(&v));
3131 fn test_size_hint() {
3132 let xs = [(1, 1), (2, 2), (3, 3), (4, 4), (5, 5), (6, 6)];
3134 let map: HashMap<_, _> = xs.iter().cloned().collect();
3136 let mut iter = map.iter();
3138 for _ in iter.by_ref().take(3) {}
3140 assert_eq!(iter.size_hint(), (3, Some(3)));
3144 fn test_iter_len() {
3145 let xs = [(1, 1), (2, 2), (3, 3), (4, 4), (5, 5), (6, 6)];
3147 let map: HashMap<_, _> = xs.iter().cloned().collect();
3149 let mut iter = map.iter();
3151 for _ in iter.by_ref().take(3) {}
3153 assert_eq!(iter.len(), 3);
3157 fn test_mut_size_hint() {
3158 let xs = [(1, 1), (2, 2), (3, 3), (4, 4), (5, 5), (6, 6)];
3160 let mut map: HashMap<_, _> = xs.iter().cloned().collect();
3162 let mut iter = map.iter_mut();
3164 for _ in iter.by_ref().take(3) {}
3166 assert_eq!(iter.size_hint(), (3, Some(3)));
3170 fn test_iter_mut_len() {
3171 let xs = [(1, 1), (2, 2), (3, 3), (4, 4), (5, 5), (6, 6)];
3173 let mut map: HashMap<_, _> = xs.iter().cloned().collect();
3175 let mut iter = map.iter_mut();
3177 for _ in iter.by_ref().take(3) {}
3179 assert_eq!(iter.len(), 3);
3184 let mut map = HashMap::new();
3190 assert_eq!(map[&2], 1);
3195 fn test_index_nonexistent() {
3196 let mut map = HashMap::new();
3207 let xs = [(1, 10), (2, 20), (3, 30), (4, 40), (5, 50), (6, 60)];
3209 let mut map: HashMap<_, _> = xs.iter().cloned().collect();
3211 // Existing key (insert)
3212 match map.entry(1) {
3213 Vacant(_) => unreachable!(),
3214 Occupied(mut view) => {
3215 assert_eq!(view.get(), &10);
3216 assert_eq!(view.insert(100), 10);
3219 assert_eq!(map.get(&1).unwrap(), &100);
3220 assert_eq!(map.len(), 6);
3223 // Existing key (update)
3224 match map.entry(2) {
3225 Vacant(_) => unreachable!(),
3226 Occupied(mut view) => {
3227 let v = view.get_mut();
3228 let new_v = (*v) * 10;
3232 assert_eq!(map.get(&2).unwrap(), &200);
3233 assert_eq!(map.len(), 6);
3235 // Existing key (take)
3236 match map.entry(3) {
3237 Vacant(_) => unreachable!(),
3239 assert_eq!(view.remove(), 30);
3242 assert_eq!(map.get(&3), None);
3243 assert_eq!(map.len(), 5);
3246 // Inexistent key (insert)
3247 match map.entry(10) {
3248 Occupied(_) => unreachable!(),
3250 assert_eq!(*view.insert(1000), 1000);
3253 assert_eq!(map.get(&10).unwrap(), &1000);
3254 assert_eq!(map.len(), 6);
3258 fn test_entry_take_doesnt_corrupt() {
3259 #![allow(deprecated)] //rand
3261 fn check(m: &HashMap<isize, ()>) {
3263 assert!(m.contains_key(k),
3264 "{} is in keys() but not in the map?", k);
3268 let mut m = HashMap::new();
3269 let mut rng = thread_rng();
3271 // Populate the map with some items.
3273 let x = rng.gen_range(-10, 10);
3278 let x = rng.gen_range(-10, 10);
3282 println!("{}: remove {}", i, x);
3292 fn test_extend_ref() {
3293 let mut a = HashMap::new();
3295 let mut b = HashMap::new();
3297 b.insert(3, "three");
3301 assert_eq!(a.len(), 3);
3302 assert_eq!(a[&1], "one");
3303 assert_eq!(a[&2], "two");
3304 assert_eq!(a[&3], "three");
3308 fn test_capacity_not_less_than_len() {
3309 let mut a = HashMap::new();
3317 assert!(a.capacity() > a.len());
3319 let free = a.capacity() - a.len();
3325 assert_eq!(a.len(), a.capacity());
3327 // Insert at capacity should cause allocation.
3329 assert!(a.capacity() > a.len());
3333 fn test_occupied_entry_key() {
3334 let mut a = HashMap::new();
3335 let key = "hello there";
3336 let value = "value goes here";
3337 assert!(a.is_empty());
3338 a.insert(key.clone(), value.clone());
3339 assert_eq!(a.len(), 1);
3340 assert_eq!(a[key], value);
3342 match a.entry(key.clone()) {
3343 Vacant(_) => panic!(),
3344 Occupied(e) => assert_eq!(key, *e.key()),
3346 assert_eq!(a.len(), 1);
3347 assert_eq!(a[key], value);
3351 fn test_vacant_entry_key() {
3352 let mut a = HashMap::new();
3353 let key = "hello there";
3354 let value = "value goes here";
3356 assert!(a.is_empty());
3357 match a.entry(key.clone()) {
3358 Occupied(_) => panic!(),
3360 assert_eq!(key, *e.key());
3361 e.insert(value.clone());
3364 assert_eq!(a.len(), 1);
3365 assert_eq!(a[key], value);
3370 let mut map: HashMap<isize, isize> = (0..100).map(|x|(x, x*10)).collect();
3372 map.retain(|&k, _| k % 2 == 0);
3373 assert_eq!(map.len(), 50);
3374 assert_eq!(map[&2], 20);
3375 assert_eq!(map[&4], 40);
3376 assert_eq!(map[&6], 60);
3380 fn test_adaptive() {
3381 const TEST_LEN: usize = 5000;
3382 // by cloning we get maps with the same hasher seed
3383 let mut first = HashMap::new();
3384 let mut second = first.clone();
3385 first.extend((0..TEST_LEN).map(|i| (i, i)));
3386 second.extend((TEST_LEN..TEST_LEN * 2).map(|i| (i, i)));
3388 for (&k, &v) in &second {
3389 let prev_cap = first.capacity();
3390 let expect_grow = first.len() == prev_cap;
3392 if !expect_grow && first.capacity() != prev_cap {
3396 panic!("Adaptive early resize failed");
3400 fn test_placement_in() {
3401 let mut map = HashMap::new();
3402 map.extend((0..10).map(|i| (i, i)));
3404 map.entry(100) <- 100;
3405 assert_eq!(map[&100], 100);
3408 assert_eq!(map[&0], 10);
3410 assert_eq!(map.len(), 11);
3414 fn test_placement_panic() {
3415 let mut map = HashMap::new();
3416 map.extend((0..10).map(|i| (i, i)));
3418 fn mkpanic() -> usize { panic!() }
3420 // modify existing key
3421 // when panic happens, previous key is removed.
3422 let _ = panic::catch_unwind(panic::AssertUnwindSafe(|| { map.entry(0) <- mkpanic(); }));
3423 assert_eq!(map.len(), 9);
3424 assert!(!map.contains_key(&0));
3427 let _ = panic::catch_unwind(panic::AssertUnwindSafe(|| { map.entry(100) <- mkpanic(); }));
3428 assert_eq!(map.len(), 9);
3429 assert!(!map.contains_key(&100));
3433 fn test_placement_drop() {
3435 struct TestV<'a>(&'a mut bool);
3436 impl<'a> Drop for TestV<'a> {
3437 fn drop(&mut self) {
3438 if !*self.0 { panic!("value double drop!"); } // no double drop
3443 fn makepanic<'a>() -> TestV<'a> { panic!() }
3445 let mut can_drop = true;
3446 let mut hm = HashMap::new();
3447 hm.insert(0, TestV(&mut can_drop));
3448 let _ = panic::catch_unwind(panic::AssertUnwindSafe(|| { hm.entry(0) <- makepanic(); }));
3449 assert_eq!(hm.len(), 0);