library/core/src/hash/mod.rs

   1 //! Generic hashing support.
   2 //!
   3 //! This module provides a generic way to compute the [hash] of a value.
   4 //! Hashes are most commonly used with [`HashMap`] and [`HashSet`].
   5 //!
   6 //! [hash]: https://en.wikipedia.org/wiki/Hash_function
   7 //! [`HashMap`]: ../../std/collections/struct.HashMap.html
   8 //! [`HashSet`]: ../../std/collections/struct.HashSet.html
   9 //!
  10 //! The simplest way to make a type hashable is to use `#[derive(Hash)]`:
  11 //!
  12 //! # Examples
  13 //!
  14 //! ```rust
  15 //! use std::collections::hash_map::DefaultHasher;
  16 //! use std::hash::{Hash, Hasher};
  17 //!
  18 //! #[derive(Hash)]
  19 //! struct Person {
  20 //!     id: u32,
  21 //!     name: String,
  22 //!     phone: u64,
  23 //! }
  24 //!
  25 //! let person1 = Person {
  26 //!     id: 5,
  27 //!     name: "Janet".to_string(),
  28 //!     phone: 555_666_7777,
  29 //! };
  30 //! let person2 = Person {
  31 //!     id: 5,
  32 //!     name: "Bob".to_string(),
  33 //!     phone: 555_666_7777,
  34 //! };
  35 //!
  36 //! assert!(calculate_hash(&person1) != calculate_hash(&person2));
  37 //!
  38 //! fn calculate_hash<T: Hash>(t: &T) -> u64 {
  39 //!     let mut s = DefaultHasher::new();
  40 //!     t.hash(&mut s);
  41 //!     s.finish()
  42 //! }
  43 //! ```
  44 //!
  45 //! If you need more control over how a value is hashed, you need to implement
  46 //! the [`Hash`] trait:
  47 //!
  48 //! ```rust
  49 //! use std::collections::hash_map::DefaultHasher;
  50 //! use std::hash::{Hash, Hasher};
  51 //!
  52 //! struct Person {
  53 //!     id: u32,
  54 //!     # #[allow(dead_code)]
  55 //!     name: String,
  56 //!     phone: u64,
  57 //! }
  58 //!
  59 //! impl Hash for Person {
  60 //!     fn hash<H: Hasher>(&self, state: &mut H) {
  61 //!         self.id.hash(state);
  62 //!         self.phone.hash(state);
  63 //!     }
  64 //! }
  65 //!
  66 //! let person1 = Person {
  67 //!     id: 5,
  68 //!     name: "Janet".to_string(),
  69 //!     phone: 555_666_7777,
  70 //! };
  71 //! let person2 = Person {
  72 //!     id: 5,
  73 //!     name: "Bob".to_string(),
  74 //!     phone: 555_666_7777,
  75 //! };
  76 //!
  77 //! assert_eq!(calculate_hash(&person1), calculate_hash(&person2));
  78 //!
  79 //! fn calculate_hash<T: Hash>(t: &T) -> u64 {
  80 //!     let mut s = DefaultHasher::new();
  81 //!     t.hash(&mut s);
  82 //!     s.finish()
  83 //! }
  84 //! ```
  85
  86 #![stable(feature = "rust1", since = "1.0.0")]
  87
  88 use crate::fmt;
  89 use crate::marker;
  90
  91 #[stable(feature = "rust1", since = "1.0.0")]
  92 #[allow(deprecated)]
  93 pub use self::sip::SipHasher;
  94
  95 #[unstable(feature = "hashmap_internals", issue = "none")]
  96 #[allow(deprecated)]
  97 #[doc(hidden)]
  98 pub use self::sip::SipHasher13;
  99
 100 mod sip;
 101
 102 /// A hashable type.
 103 ///
 104 /// Types implementing `Hash` are able to be [`hash`]ed with an instance of
 105 /// [`Hasher`].
 106 ///
 107 /// ## Implementing `Hash`
 108 ///
 109 /// You can derive `Hash` with `#[derive(Hash)]` if all fields implement `Hash`.
 110 /// The resulting hash will be the combination of the values from calling
 111 /// [`hash`] on each field.
 112 ///
 113 /// ```
 114 /// #[derive(Hash)]
 115 /// struct Rustacean {
 116 ///     name: String,
 117 ///     country: String,
 118 /// }
 119 /// ```
 120 ///
 121 /// If you need more control over how a value is hashed, you can of course
 122 /// implement the `Hash` trait yourself:
 123 ///
 124 /// ```
 125 /// use std::hash::{Hash, Hasher};
 126 ///
 127 /// struct Person {
 128 ///     id: u32,
 129 ///     name: String,
 130 ///     phone: u64,
 131 /// }
 132 ///
 133 /// impl Hash for Person {
 134 ///     fn hash<H: Hasher>(&self, state: &mut H) {
 135 ///         self.id.hash(state);
 136 ///         self.phone.hash(state);
 137 ///     }
 138 /// }
 139 /// ```
 140 ///
 141 /// ## `Hash` and `Eq`
 142 ///
 143 /// When implementing both `Hash` and [`Eq`], it is important that the following
 144 /// property holds:
 145 ///
 146 /// ```text
 147 /// k1 == k2 -> hash(k1) == hash(k2)
 148 /// ```
 149 ///
 150 /// In other words, if two keys are equal, their hashes must also be equal.
 151 /// [`HashMap`] and [`HashSet`] both rely on this behavior.
 152 ///
 153 /// Thankfully, you won't need to worry about upholding this property when
 154 /// deriving both [`Eq`] and `Hash` with `#[derive(PartialEq, Eq, Hash)]`.
 155 ///
 156 /// [`HashMap`]: ../../std/collections/struct.HashMap.html
 157 /// [`HashSet`]: ../../std/collections/struct.HashSet.html
 158 /// [`hash`]: Hash::hash
 159 #[stable(feature = "rust1", since = "1.0.0")]
 160 #[rustc_diagnostic_item = "Hash"]
 161 pub trait Hash {
 162     /// Feeds this value into the given [`Hasher`].
 163     ///
 164     /// # Examples
 165     ///
 166     /// ```
 167     /// use std::collections::hash_map::DefaultHasher;
 168     /// use std::hash::{Hash, Hasher};
 169     ///
 170     /// let mut hasher = DefaultHasher::new();
 171     /// 7920.hash(&mut hasher);
 172     /// println!("Hash is {:x}!", hasher.finish());
 173     /// ```
 174     #[stable(feature = "rust1", since = "1.0.0")]
 175     fn hash<H: Hasher>(&self, state: &mut H);
 176
 177     /// Feeds a slice of this type into the given [`Hasher`].
 178     ///
 179     /// This method is meant as a convenience, but its implementation is
 180     /// also explicitly left unspecified. It isn't guaranteed to be
 181     /// equivalent to repeated calls of [`hash`] and implementations of
 182     /// [`Hash`] should keep that in mind and call [`hash`] themselves
 183     /// if the slice isn't treated as a whole unit in the [`PartialEq`]
 184     /// implementation.
 185     ///
 186     /// For example, a [`VecDeque`] implementation might naïvely call
 187     /// [`as_slices`] and then [`hash_slice`] on each slice, but this
 188     /// is wrong since the two slices can change with a call to
 189     /// [`make_contiguous`] without affecting the [`PartialEq`]
 190     /// result. Since these slices aren't treated as singular
 191     /// units, and instead part of a larger deque, this method cannot
 192     /// be used.
 193     ///
 194     /// # Examples
 195     ///
 196     /// ```
 197     /// use std::collections::hash_map::DefaultHasher;
 198     /// use std::hash::{Hash, Hasher};
 199     ///
 200     /// let mut hasher = DefaultHasher::new();
 201     /// let numbers = [6, 28, 496, 8128];
 202     /// Hash::hash_slice(&numbers, &mut hasher);
 203     /// println!("Hash is {:x}!", hasher.finish());
 204     /// ```
 205     ///
 206     /// [`VecDeque`]: ../../std/collections/struct.VecDeque.html
 207     /// [`as_slices`]: ../../std/collections/struct.VecDeque.html#method.as_slices
 208     /// [`make_contiguous`]: ../../std/collections/struct.VecDeque.html#method.make_contiguous
 209     /// [`hash`]: Hash::hash
 210     /// [`hash_slice`]: Hash::hash_slice
 211     #[stable(feature = "hash_slice", since = "1.3.0")]
 212     fn hash_slice<H: Hasher>(data: &[Self], state: &mut H)
 213     where
 214         Self: Sized,
 215     {
 216         for piece in data {
 217             piece.hash(state);
 218         }
 219     }
 220 }
 221
 222 // Separate module to reexport the macro `Hash` from prelude without the trait `Hash`.
 223 pub(crate) mod macros {
 224     /// Derive macro generating an impl of the trait `Hash`.
 225     #[rustc_builtin_macro]
 226     #[stable(feature = "builtin_macro_prelude", since = "1.38.0")]
 227     #[allow_internal_unstable(core_intrinsics)]
 228     pub macro Hash($item:item) {
 229         /* compiler built-in */
 230     }
 231 }
 232 #[stable(feature = "builtin_macro_prelude", since = "1.38.0")]
 233 #[doc(inline)]
 234 pub use macros::Hash;
 235
 236 /// A trait for hashing an arbitrary stream of bytes.
 237 ///
 238 /// Instances of `Hasher` usually represent state that is changed while hashing
 239 /// data.
 240 ///
 241 /// `Hasher` provides a fairly basic interface for retrieving the generated hash
 242 /// (with [`finish`]), and writing integers as well as slices of bytes into an
 243 /// instance (with [`write`] and [`write_u8`] etc.). Most of the time, `Hasher`
 244 /// instances are used in conjunction with the [`Hash`] trait.
 245 ///
 246 /// This trait makes no assumptions about how the various `write_*` methods are
 247 /// defined and implementations of [`Hash`] should not assume that they work one
 248 /// way or another. You cannot assume, for example, that a [`write_u32`] call is
 249 /// equivalent to four calls of [`write_u8`].
 250 ///
 251 /// # Examples
 252 ///
 253 /// ```
 254 /// use std::collections::hash_map::DefaultHasher;
 255 /// use std::hash::Hasher;
 256 ///
 257 /// let mut hasher = DefaultHasher::new();
 258 ///
 259 /// hasher.write_u32(1989);
 260 /// hasher.write_u8(11);
 261 /// hasher.write_u8(9);
 262 /// hasher.write(b"Huh?");
 263 ///
 264 /// println!("Hash is {:x}!", hasher.finish());
 265 /// ```
 266 ///
 267 /// [`finish`]: Hasher::finish
 268 /// [`write`]: Hasher::write
 269 /// [`write_u8`]: Hasher::write_u8
 270 /// [`write_u32`]: Hasher::write_u32
 271 #[stable(feature = "rust1", since = "1.0.0")]
 272 pub trait Hasher {
 273     /// Returns the hash value for the values written so far.
 274     ///
 275     /// Despite its name, the method does not reset the hasher’s internal
 276     /// state. Additional [`write`]s will continue from the current value.
 277     /// If you need to start a fresh hash value, you will have to create
 278     /// a new hasher.
 279     ///
 280     /// # Examples
 281     ///
 282     /// ```
 283     /// use std::collections::hash_map::DefaultHasher;
 284     /// use std::hash::Hasher;
 285     ///
 286     /// let mut hasher = DefaultHasher::new();
 287     /// hasher.write(b"Cool!");
 288     ///
 289     /// println!("Hash is {:x}!", hasher.finish());
 290     /// ```
 291     ///
 292     /// [`write`]: Hasher::write
 293     #[stable(feature = "rust1", since = "1.0.0")]
 294     fn finish(&self) -> u64;
 295
 296     /// Writes some data into this `Hasher`.
 297     ///
 298     /// # Examples
 299     ///
 300     /// ```
 301     /// use std::collections::hash_map::DefaultHasher;
 302     /// use std::hash::Hasher;
 303     ///
 304     /// let mut hasher = DefaultHasher::new();
 305     /// let data = [0x01, 0x23, 0x45, 0x67, 0x89, 0xab, 0xcd, 0xef];
 306     ///
 307     /// hasher.write(&data);
 308     ///
 309     /// println!("Hash is {:x}!", hasher.finish());
 310     /// ```
 311     #[stable(feature = "rust1", since = "1.0.0")]
 312     fn write(&mut self, bytes: &[u8]);
 313
 314     /// Writes a single `u8` into this hasher.
 315     #[inline]
 316     #[stable(feature = "hasher_write", since = "1.3.0")]
 317     fn write_u8(&mut self, i: u8) {
 318         self.write(&[i])
 319     }
 320     /// Writes a single `u16` into this hasher.
 321     #[inline]
 322     #[stable(feature = "hasher_write", since = "1.3.0")]
 323     fn write_u16(&mut self, i: u16) {
 324         self.write(&i.to_ne_bytes())
 325     }
 326     /// Writes a single `u32` into this hasher.
 327     #[inline]
 328     #[stable(feature = "hasher_write", since = "1.3.0")]
 329     fn write_u32(&mut self, i: u32) {
 330         self.write(&i.to_ne_bytes())
 331     }
 332     /// Writes a single `u64` into this hasher.
 333     #[inline]
 334     #[stable(feature = "hasher_write", since = "1.3.0")]
 335     fn write_u64(&mut self, i: u64) {
 336         self.write(&i.to_ne_bytes())
 337     }
 338     /// Writes a single `u128` into this hasher.
 339     #[inline]
 340     #[stable(feature = "i128", since = "1.26.0")]
 341     fn write_u128(&mut self, i: u128) {
 342         self.write(&i.to_ne_bytes())
 343     }
 344     /// Writes a single `usize` into this hasher.
 345     #[inline]
 346     #[stable(feature = "hasher_write", since = "1.3.0")]
 347     fn write_usize(&mut self, i: usize) {
 348         self.write(&i.to_ne_bytes())
 349     }
 350
 351     /// Writes a single `i8` into this hasher.
 352     #[inline]
 353     #[stable(feature = "hasher_write", since = "1.3.0")]
 354     fn write_i8(&mut self, i: i8) {
 355         self.write_u8(i as u8)
 356     }
 357     /// Writes a single `i16` into this hasher.
 358     #[inline]
 359     #[stable(feature = "hasher_write", since = "1.3.0")]
 360     fn write_i16(&mut self, i: i16) {
 361         self.write_u16(i as u16)
 362     }
 363     /// Writes a single `i32` into this hasher.
 364     #[inline]
 365     #[stable(feature = "hasher_write", since = "1.3.0")]
 366     fn write_i32(&mut self, i: i32) {
 367         self.write_u32(i as u32)
 368     }
 369     /// Writes a single `i64` into this hasher.
 370     #[inline]
 371     #[stable(feature = "hasher_write", since = "1.3.0")]
 372     fn write_i64(&mut self, i: i64) {
 373         self.write_u64(i as u64)
 374     }
 375     /// Writes a single `i128` into this hasher.
 376     #[inline]
 377     #[stable(feature = "i128", since = "1.26.0")]
 378     fn write_i128(&mut self, i: i128) {
 379         self.write_u128(i as u128)
 380     }
 381     /// Writes a single `isize` into this hasher.
 382     #[inline]
 383     #[stable(feature = "hasher_write", since = "1.3.0")]
 384     fn write_isize(&mut self, i: isize) {
 385         self.write_usize(i as usize)
 386     }
 387 }
 388
 389 #[stable(feature = "indirect_hasher_impl", since = "1.22.0")]
 390 impl<H: Hasher + ?Sized> Hasher for &mut H {
 391     fn finish(&self) -> u64 {
 392         (**self).finish()
 393     }
 394     fn write(&mut self, bytes: &[u8]) {
 395         (**self).write(bytes)
 396     }
 397     fn write_u8(&mut self, i: u8) {
 398         (**self).write_u8(i)
 399     }
 400     fn write_u16(&mut self, i: u16) {
 401         (**self).write_u16(i)
 402     }
 403     fn write_u32(&mut self, i: u32) {
 404         (**self).write_u32(i)
 405     }
 406     fn write_u64(&mut self, i: u64) {
 407         (**self).write_u64(i)
 408     }
 409     fn write_u128(&mut self, i: u128) {
 410         (**self).write_u128(i)
 411     }
 412     fn write_usize(&mut self, i: usize) {
 413         (**self).write_usize(i)
 414     }
 415     fn write_i8(&mut self, i: i8) {
 416         (**self).write_i8(i)
 417     }
 418     fn write_i16(&mut self, i: i16) {
 419         (**self).write_i16(i)
 420     }
 421     fn write_i32(&mut self, i: i32) {
 422         (**self).write_i32(i)
 423     }
 424     fn write_i64(&mut self, i: i64) {
 425         (**self).write_i64(i)
 426     }
 427     fn write_i128(&mut self, i: i128) {
 428         (**self).write_i128(i)
 429     }
 430     fn write_isize(&mut self, i: isize) {
 431         (**self).write_isize(i)
 432     }
 433 }
 434
 435 /// A trait for creating instances of [`Hasher`].
 436 ///
 437 /// A `BuildHasher` is typically used (e.g., by [`HashMap`]) to create
 438 /// [`Hasher`]s for each key such that they are hashed independently of one
 439 /// another, since [`Hasher`]s contain state.
 440 ///
 441 /// For each instance of `BuildHasher`, the [`Hasher`]s created by
 442 /// [`build_hasher`] should be identical. That is, if the same stream of bytes
 443 /// is fed into each hasher, the same output will also be generated.
 444 ///
 445 /// # Examples
 446 ///
 447 /// ```
 448 /// use std::collections::hash_map::RandomState;
 449 /// use std::hash::{BuildHasher, Hasher};
 450 ///
 451 /// let s = RandomState::new();
 452 /// let mut hasher_1 = s.build_hasher();
 453 /// let mut hasher_2 = s.build_hasher();
 454 ///
 455 /// hasher_1.write_u32(8128);
 456 /// hasher_2.write_u32(8128);
 457 ///
 458 /// assert_eq!(hasher_1.finish(), hasher_2.finish());
 459 /// ```
 460 ///
 461 /// [`build_hasher`]: BuildHasher::build_hasher
 462 /// [`HashMap`]: ../../std/collections/struct.HashMap.html
 463 #[stable(since = "1.7.0", feature = "build_hasher")]
 464 pub trait BuildHasher {
 465     /// Type of the hasher that will be created.
 466     #[stable(since = "1.7.0", feature = "build_hasher")]
 467     type Hasher: Hasher;
 468
 469     /// Creates a new hasher.
 470     ///
 471     /// Each call to `build_hasher` on the same instance should produce identical
 472     /// [`Hasher`]s.
 473     ///
 474     /// # Examples
 475     ///
 476     /// ```
 477     /// use std::collections::hash_map::RandomState;
 478     /// use std::hash::BuildHasher;
 479     ///
 480     /// let s = RandomState::new();
 481     /// let new_s = s.build_hasher();
 482     /// ```
 483     #[stable(since = "1.7.0", feature = "build_hasher")]
 484     fn build_hasher(&self) -> Self::Hasher;
 485
 486     /// Calculates the hash of a single value.
 487     ///
 488     /// This is intended as a convenience for code which *consumes* hashes, such
 489     /// as the implementation of a hash table or in unit tests that check
 490     /// whether a custom [`Hash`] implementation behaves as expected.
 491     ///
 492     /// This must not be used in any code which *creates* hashes, such as in an
 493     /// implementation of [`Hash`].  The way to create a combined hash of
 494     /// multiple values is to call [`Hash::hash`] multiple times using the same
 495     /// [`Hasher`], not to call this method repeatedly and combine the results.
 496     ///
 497     /// # Example
 498     ///
 499     /// ```
 500     /// #![feature(build_hasher_simple_hash_one)]
 501     ///
 502     /// use std::cmp::{max, min};
 503     /// use std::hash::{BuildHasher, Hash, Hasher};
 504     /// struct OrderAmbivalentPair<T: Ord>(T, T);
 505     /// impl<T: Ord + Hash> Hash for OrderAmbivalentPair<T> {
 506     ///     fn hash<H: Hasher>(&self, hasher: &mut H) {
 507     ///         min(&self.0, &self.1).hash(hasher);
 508     ///         max(&self.0, &self.1).hash(hasher);
 509     ///     }
 510     /// }
 511     ///
 512     /// // Then later, in a `#[test]` for the type...
 513     /// let bh = std::collections::hash_map::RandomState::new();
 514     /// assert_eq!(
 515     ///     bh.hash_one(OrderAmbivalentPair(1, 2)),
 516     ///     bh.hash_one(OrderAmbivalentPair(2, 1))
 517     /// );
 518     /// assert_eq!(
 519     ///     bh.hash_one(OrderAmbivalentPair(10, 2)),
 520     ///     bh.hash_one(&OrderAmbivalentPair(2, 10))
 521     /// );
 522     /// ```
 523     #[unstable(feature = "build_hasher_simple_hash_one", issue = "86161")]
 524     fn hash_one<T: Hash>(&self, x: T) -> u64
 525     where
 526         Self: Sized,
 527     {
 528         let mut hasher = self.build_hasher();
 529         x.hash(&mut hasher);
 530         hasher.finish()
 531     }
 532 }
 533
 534 /// Used to create a default [`BuildHasher`] instance for types that implement
 535 /// [`Hasher`] and [`Default`].
 536 ///
 537 /// `BuildHasherDefault<H>` can be used when a type `H` implements [`Hasher`] and
 538 /// [`Default`], and you need a corresponding [`BuildHasher`] instance, but none is
 539 /// defined.
 540 ///
 541 /// Any `BuildHasherDefault` is [zero-sized]. It can be created with
 542 /// [`default`][method.default]. When using `BuildHasherDefault` with [`HashMap`] or
 543 /// [`HashSet`], this doesn't need to be done, since they implement appropriate
 544 /// [`Default`] instances themselves.
 545 ///
 546 /// # Examples
 547 ///
 548 /// Using `BuildHasherDefault` to specify a custom [`BuildHasher`] for
 549 /// [`HashMap`]:
 550 ///
 551 /// ```
 552 /// use std::collections::HashMap;
 553 /// use std::hash::{BuildHasherDefault, Hasher};
 554 ///
 555 /// #[derive(Default)]
 556 /// struct MyHasher;
 557 ///
 558 /// impl Hasher for MyHasher {
 559 ///     fn write(&mut self, bytes: &[u8]) {
 560 ///         // Your hashing algorithm goes here!
 561 ///        unimplemented!()
 562 ///     }
 563 ///
 564 ///     fn finish(&self) -> u64 {
 565 ///         // Your hashing algorithm goes here!
 566 ///         unimplemented!()
 567 ///     }
 568 /// }
 569 ///
 570 /// type MyBuildHasher = BuildHasherDefault<MyHasher>;
 571 ///
 572 /// let hash_map = HashMap::<u32, u32, MyBuildHasher>::default();
 573 /// ```
 574 ///
 575 /// [method.default]: BuildHasherDefault::default
 576 /// [`HashMap`]: ../../std/collections/struct.HashMap.html
 577 /// [`HashSet`]: ../../std/collections/struct.HashSet.html
 578 /// [zero-sized]: https://doc.rust-lang.org/nomicon/exotic-sizes.html#zero-sized-types-zsts
 579 #[stable(since = "1.7.0", feature = "build_hasher")]
 580 pub struct BuildHasherDefault<H>(marker::PhantomData<H>);
 581
 582 #[stable(since = "1.9.0", feature = "core_impl_debug")]
 583 impl<H> fmt::Debug for BuildHasherDefault<H> {
 584     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 585         f.debug_struct("BuildHasherDefault").finish()
 586     }
 587 }
 588
 589 #[stable(since = "1.7.0", feature = "build_hasher")]
 590 impl<H: Default + Hasher> BuildHasher for BuildHasherDefault<H> {
 591     type Hasher = H;
 592
 593     fn build_hasher(&self) -> H {
 594         H::default()
 595     }
 596 }
 597
 598 #[stable(since = "1.7.0", feature = "build_hasher")]
 599 impl<H> Clone for BuildHasherDefault<H> {
 600     fn clone(&self) -> BuildHasherDefault<H> {
 601         BuildHasherDefault(marker::PhantomData)
 602     }
 603 }
 604
 605 #[stable(since = "1.7.0", feature = "build_hasher")]
 606 #[rustc_const_unstable(feature = "const_default_impls", issue = "87864")]
 607 impl<H> const Default for BuildHasherDefault<H> {
 608     fn default() -> BuildHasherDefault<H> {
 609         BuildHasherDefault(marker::PhantomData)
 610     }
 611 }
 612
 613 #[stable(since = "1.29.0", feature = "build_hasher_eq")]
 614 impl<H> PartialEq for BuildHasherDefault<H> {
 615     fn eq(&self, _other: &BuildHasherDefault<H>) -> bool {
 616         true
 617     }
 618 }
 619
 620 #[stable(since = "1.29.0", feature = "build_hasher_eq")]
 621 impl<H> Eq for BuildHasherDefault<H> {}
 622
 623 mod impls {
 624     use crate::mem;
 625     use crate::slice;
 626
 627     use super::*;
 628
 629     macro_rules! impl_write {
 630         ($(($ty:ident, $meth:ident),)*) => {$(
 631             #[stable(feature = "rust1", since = "1.0.0")]
 632             impl Hash for $ty {
 633                 #[inline]
 634                 fn hash<H: Hasher>(&self, state: &mut H) {
 635                     state.$meth(*self)
 636                 }
 637
 638                 #[inline]
 639                 fn hash_slice<H: Hasher>(data: &[$ty], state: &mut H) {
 640                     let newlen = data.len() * mem::size_of::<$ty>();
 641                     let ptr = data.as_ptr() as *const u8;
 642                     // SAFETY: `ptr` is valid and aligned, as this macro is only used
 643                     // for numeric primitives which have no padding. The new slice only
 644                     // spans across `data` and is never mutated, and its total size is the
 645                     // same as the original `data` so it can't be over `isize::MAX`.
 646                     state.write(unsafe { slice::from_raw_parts(ptr, newlen) })
 647                 }
 648             }
 649         )*}
 650     }
 651
 652     impl_write! {
 653         (u8, write_u8),
 654         (u16, write_u16),
 655         (u32, write_u32),
 656         (u64, write_u64),
 657         (usize, write_usize),
 658         (i8, write_i8),
 659         (i16, write_i16),
 660         (i32, write_i32),
 661         (i64, write_i64),
 662         (isize, write_isize),
 663         (u128, write_u128),
 664         (i128, write_i128),
 665     }
 666
 667     #[stable(feature = "rust1", since = "1.0.0")]
 668     impl Hash for bool {
 669         #[inline]
 670         fn hash<H: Hasher>(&self, state: &mut H) {
 671             state.write_u8(*self as u8)
 672         }
 673     }
 674
 675     #[stable(feature = "rust1", since = "1.0.0")]
 676     impl Hash for char {
 677         #[inline]
 678         fn hash<H: Hasher>(&self, state: &mut H) {
 679             state.write_u32(*self as u32)
 680         }
 681     }
 682
 683     #[stable(feature = "rust1", since = "1.0.0")]
 684     impl Hash for str {
 685         #[inline]
 686         fn hash<H: Hasher>(&self, state: &mut H) {
 687             state.write(self.as_bytes());
 688             state.write_u8(0xff)
 689         }
 690     }
 691
 692     #[stable(feature = "never_hash", since = "1.29.0")]
 693     impl Hash for ! {
 694         #[inline]
 695         fn hash<H: Hasher>(&self, _: &mut H) {
 696             *self
 697         }
 698     }
 699
 700     macro_rules! impl_hash_tuple {
 701         () => (
 702             #[stable(feature = "rust1", since = "1.0.0")]
 703             impl Hash for () {
 704                 #[inline]
 705                 fn hash<H: Hasher>(&self, _state: &mut H) {}
 706             }
 707         );
 708
 709         ( $($name:ident)+) => (
 710             #[stable(feature = "rust1", since = "1.0.0")]
 711             impl<$($name: Hash),+> Hash for ($($name,)+) where last_type!($($name,)+): ?Sized {
 712                 #[allow(non_snake_case)]
 713                 #[inline]
 714                 fn hash<S: Hasher>(&self, state: &mut S) {
 715                     let ($(ref $name,)+) = *self;
 716                     $($name.hash(state);)+
 717                 }
 718             }
 719         );
 720     }
 721
 722     macro_rules! last_type {
 723         ($a:ident,) => { $a };
 724         ($a:ident, $($rest_a:ident,)+) => { last_type!($($rest_a,)+) };
 725     }
 726
 727     impl_hash_tuple! {}
 728     impl_hash_tuple! { A }
 729     impl_hash_tuple! { A B }
 730     impl_hash_tuple! { A B C }
 731     impl_hash_tuple! { A B C D }
 732     impl_hash_tuple! { A B C D E }
 733     impl_hash_tuple! { A B C D E F }
 734     impl_hash_tuple! { A B C D E F G }
 735     impl_hash_tuple! { A B C D E F G H }
 736     impl_hash_tuple! { A B C D E F G H I }
 737     impl_hash_tuple! { A B C D E F G H I J }
 738     impl_hash_tuple! { A B C D E F G H I J K }
 739     impl_hash_tuple! { A B C D E F G H I J K L }
 740
 741     #[stable(feature = "rust1", since = "1.0.0")]
 742     impl<T: Hash> Hash for [T] {
 743         #[inline]
 744         fn hash<H: Hasher>(&self, state: &mut H) {
 745             self.len().hash(state);
 746             Hash::hash_slice(self, state)
 747         }
 748     }
 749
 750     #[stable(feature = "rust1", since = "1.0.0")]
 751     impl<T: ?Sized + Hash> Hash for &T {
 752         #[inline]
 753         fn hash<H: Hasher>(&self, state: &mut H) {
 754             (**self).hash(state);
 755         }
 756     }
 757
 758     #[stable(feature = "rust1", since = "1.0.0")]
 759     impl<T: ?Sized + Hash> Hash for &mut T {
 760         #[inline]
 761         fn hash<H: Hasher>(&self, state: &mut H) {
 762             (**self).hash(state);
 763         }
 764     }
 765
 766     #[stable(feature = "rust1", since = "1.0.0")]
 767     impl<T: ?Sized> Hash for *const T {
 768         #[inline]
 769         fn hash<H: Hasher>(&self, state: &mut H) {
 770             let (address, metadata) = self.to_raw_parts();
 771             state.write_usize(address as usize);
 772             metadata.hash(state);
 773         }
 774     }
 775
 776     #[stable(feature = "rust1", since = "1.0.0")]
 777     impl<T: ?Sized> Hash for *mut T {
 778         #[inline]
 779         fn hash<H: Hasher>(&self, state: &mut H) {
 780             let (address, metadata) = self.to_raw_parts();
 781             state.write_usize(address as usize);
 782             metadata.hash(state);
 783         }
 784     }
 785 }