Skip to content

Commit b5545d6

Browse files
borsbors
committed
Auto merge of #115694 - clarfonthey:std-hash-private, r=dtolnay
Add `std::hash::{DefaultHasher, RandomState}` exports (needs FCP) This implements rust-lang/libs-team#267 to move the libstd hasher types to `std::hash` where they belong, instead of `std::collections::hash_map`. <details><summary>The below no longer applies, but is kept for clarity.</summary> This is a small refactor for #27242, which moves the definitions of `RandomState` and `DefaultHasher` into `std::hash`, but in a way that won't be noticed in the public API. I've opened rust-lang/libs-team#267 as a formal ACP to move these directly into the root of `std::hash`, but for now, they're at least separated out from the collections code in a way that will make moving that around easier. I decided to simply copy the rustdoc for `std::hash` from `core::hash` since I think it would be ideal for the two to diverge longer-term, especially if the ACP is accepted. However, I would be willing to factor them out into a common markdown document if that's preferred. </details>
2 parents d4c86cf + 8337e86 commit b5545d6

File tree

27 files changed

+308
-232
lines changed

27 files changed

+308
-232
lines changed

‎compiler/rustc_middle/src/ty/error.rs

+1-2
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,7 @@ use rustc_hir::def_id::DefId;
77
use rustc_span::symbol::Symbol;
88
use rustc_target::spec::abi;
99
use std::borrow::Cow;
10-
use std::collections::hash_map::DefaultHasher;
11-
use std::hash::{Hash, Hasher};
10+
use std::hash::{DefaultHasher, Hash, Hasher};
1211
use std::path::PathBuf;
1312

1413
#[derive(Clone, Copy, Debug, PartialEq, Eq, TypeFoldable, TypeVisitable)]

‎compiler/rustc_session/src/config.rs

+1-2
Original file line numberDiff line numberDiff line change
@@ -3178,9 +3178,8 @@ pub(crate) mod dep_tracking {
31783178
use rustc_target::spec::{
31793179
RelroLevel, SanitizerSet, SplitDebuginfo, StackProtector, TargetTriple, TlsModel,
31803180
};
3181-
use std::collections::hash_map::DefaultHasher;
31823181
use std::collections::BTreeMap;
3183-
use std::hash::Hash;
3182+
use std::hash::{DefaultHasher, Hash};
31843183
use std::num::NonZeroUsize;
31853184
use std::path::PathBuf;
31863185

‎compiler/rustc_session/src/options.rs

+1-2
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,7 @@ use rustc_span::SourceFileHashAlgorithm;
1919

2020
use std::collections::BTreeMap;
2121

22-
use std::collections::hash_map::DefaultHasher;
23-
use std::hash::Hasher;
22+
use std::hash::{DefaultHasher, Hasher};
2423
use std::num::{IntErrorKind, NonZeroUsize};
2524
use std::path::PathBuf;
2625
use std::str;

‎compiler/rustc_target/src/spec/mod.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -3503,7 +3503,7 @@ impl TargetTriple {
35033503
/// If this target is a path, a hash of the path is appended to the triple returned
35043504
/// by `triple()`.
35053505
pub fn debug_triple(&self) -> String {
3506-
use std::collections::hash_map::DefaultHasher;
3506+
use std::hash::DefaultHasher;
35073507

35083508
match self {
35093509
TargetTriple::TargetTriple(triple) => triple.to_owned(),

‎library/alloc/src/lib.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -270,7 +270,7 @@ pub(crate) mod test_helpers {
270270
/// seed not being the same for every RNG invocation too.
271271
pub(crate) fn test_rng() -> rand_xorshift::XorShiftRng {
272272
use std::hash::{BuildHasher, Hash, Hasher};
273-
let mut hasher = std::collections::hash_map::RandomState::new().build_hasher();
273+
let mut hasher = std::hash::RandomState::new().build_hasher();
274274
std::panic::Location::caller().hash(&mut hasher);
275275
let hc64 = hasher.finish();
276276
let seed_vec =

‎library/alloc/src/vec/mod.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -2706,7 +2706,7 @@ impl<T: Clone, A: Allocator + Clone> Clone for Vec<T, A> {
27062706
/// ```
27072707
/// use std::hash::BuildHasher;
27082708
///
2709-
/// let b = std::collections::hash_map::RandomState::new();
2709+
/// let b = std::hash::RandomState::new();
27102710
/// let v: Vec<u8> = vec![0xa8, 0x3c, 0x09];
27112711
/// let s: &[u8] = &[0xa8, 0x3c, 0x09];
27122712
/// assert_eq!(b.hash_one(v), b.hash_one(s));

‎library/alloc/tests/lib.rs

+1-2
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,7 @@
4343
#![deny(fuzzy_provenance_casts)]
4444
#![deny(unsafe_op_in_unsafe_fn)]
4545

46-
use std::collections::hash_map::DefaultHasher;
47-
use std::hash::{Hash, Hasher};
46+
use std::hash::{DefaultHasher, Hash, Hasher};
4847

4948
mod arc;
5049
mod autotraits;

‎library/core/src/array/mod.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -297,7 +297,7 @@ impl<'a, T, const N: usize> TryFrom<&'a mut [T]> for &'a mut [T; N] {
297297
/// ```
298298
/// use std::hash::BuildHasher;
299299
///
300-
/// let b = std::collections::hash_map::RandomState::new();
300+
/// let b = std::hash::RandomState::new();
301301
/// let a: [u8; 3] = [0xa8, 0x3c, 0x09];
302302
/// let s: &[u8] = &[0xa8, 0x3c, 0x09];
303303
/// assert_eq!(b.hash_one(a), b.hash_one(s));

‎library/core/src/hash/mod.rs

+10-19
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,7 @@
1212
//! # Examples
1313
//!
1414
//! ```rust
15-
//! use std::collections::hash_map::DefaultHasher;
16-
//! use std::hash::{Hash, Hasher};
15+
//! use std::hash::{DefaultHasher, Hash, Hasher};
1716
//!
1817
//! #[derive(Hash)]
1918
//! struct Person {
@@ -46,8 +45,7 @@
4645
//! the [`Hash`] trait:
4746
//!
4847
//! ```rust
49-
//! use std::collections::hash_map::DefaultHasher;
50-
//! use std::hash::{Hash, Hasher};
48+
//! use std::hash::{DefaultHasher, Hash, Hasher};
5149
//!
5250
//! struct Person {
5351
//! id: u32,
@@ -194,8 +192,7 @@ pub trait Hash {
194192
/// # Examples
195193
///
196194
/// ```
197-
/// use std::collections::hash_map::DefaultHasher;
198-
/// use std::hash::{Hash, Hasher};
195+
/// use std::hash::{DefaultHasher, Hash, Hasher};
199196
///
200197
/// let mut hasher = DefaultHasher::new();
201198
/// 7920.hash(&mut hasher);
@@ -224,8 +221,7 @@ pub trait Hash {
224221
/// # Examples
225222
///
226223
/// ```
227-
/// use std::collections::hash_map::DefaultHasher;
228-
/// use std::hash::{Hash, Hasher};
224+
/// use std::hash::{DefaultHasher, Hash, Hasher};
229225
///
230226
/// let mut hasher = DefaultHasher::new();
231227
/// let numbers = [6, 28, 496, 8128];
@@ -300,8 +296,7 @@ pub use macros::Hash;
300296
/// # Examples
301297
///
302298
/// ```
303-
/// use std::collections::hash_map::DefaultHasher;
304-
/// use std::hash::Hasher;
299+
/// use std::hash::{DefaultHasher, Hasher};
305300
///
306301
/// let mut hasher = DefaultHasher::new();
307302
///
@@ -329,8 +324,7 @@ pub trait Hasher {
329324
/// # Examples
330325
///
331326
/// ```
332-
/// use std::collections::hash_map::DefaultHasher;
333-
/// use std::hash::Hasher;
327+
/// use std::hash::{DefaultHasher, Hasher};
334328
///
335329
/// let mut hasher = DefaultHasher::new();
336330
/// hasher.write(b"Cool!");
@@ -347,8 +341,7 @@ pub trait Hasher {
347341
/// # Examples
348342
///
349343
/// ```
350-
/// use std::collections::hash_map::DefaultHasher;
351-
/// use std::hash::Hasher;
344+
/// use std::hash::{DefaultHasher, Hasher};
352345
///
353346
/// let mut hasher = DefaultHasher::new();
354347
/// let data = [0x01, 0x23, 0x45, 0x67, 0x89, 0xab, 0xcd, 0xef];
@@ -627,8 +620,7 @@ impl<H: Hasher + ?Sized> Hasher for &mut H {
627620
/// # Examples
628621
///
629622
/// ```
630-
/// use std::collections::hash_map::RandomState;
631-
/// use std::hash::{BuildHasher, Hasher};
623+
/// use std::hash::{BuildHasher, Hasher, RandomState};
632624
///
633625
/// let s = RandomState::new();
634626
/// let mut hasher_1 = s.build_hasher();
@@ -656,8 +648,7 @@ pub trait BuildHasher {
656648
/// # Examples
657649
///
658650
/// ```
659-
/// use std::collections::hash_map::RandomState;
660-
/// use std::hash::BuildHasher;
651+
/// use std::hash::{BuildHasher, RandomState};
661652
///
662653
/// let s = RandomState::new();
663654
/// let new_s = s.build_hasher();
@@ -690,7 +681,7 @@ pub trait BuildHasher {
690681
/// }
691682
///
692683
/// // Then later, in a `#[test]` for the type...
693-
/// let bh = std::collections::hash_map::RandomState::new();
684+
/// let bh = std::hash::RandomState::new();
694685
/// assert_eq!(
695686
/// bh.hash_one(OrderAmbivalentPair(1, 2)),
696687
/// bh.hash_one(OrderAmbivalentPair(2, 1))

‎library/core/src/hash/sip.rs

+7-19
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ use crate::ptr;
1414
///
1515
/// See: <https://131002.net/siphash>
1616
#[unstable(feature = "hashmap_internals", issue = "none")]
17-
#[deprecated(since = "1.13.0", note = "use `std::collections::hash_map::DefaultHasher` instead")]
17+
#[deprecated(since = "1.13.0", note = "use `std::hash::DefaultHasher` instead")]
1818
#[derive(Debug, Clone, Default)]
1919
#[doc(hidden)]
2020
pub struct SipHasher13 {
@@ -25,7 +25,7 @@ pub struct SipHasher13 {
2525
///
2626
/// See: <https://131002.net/siphash/>
2727
#[unstable(feature = "hashmap_internals", issue = "none")]
28-
#[deprecated(since = "1.13.0", note = "use `std::collections::hash_map::DefaultHasher` instead")]
28+
#[deprecated(since = "1.13.0", note = "use `std::hash::DefaultHasher` instead")]
2929
#[derive(Debug, Clone, Default)]
3030
struct SipHasher24 {
3131
hasher: Hasher<Sip24Rounds>,
@@ -44,7 +44,7 @@ struct SipHasher24 {
4444
/// it is not intended for cryptographic purposes. As such, all
4545
/// cryptographic uses of this implementation are _strongly discouraged_.
4646
#[stable(feature = "rust1", since = "1.0.0")]
47-
#[deprecated(since = "1.13.0", note = "use `std::collections::hash_map::DefaultHasher` instead")]
47+
#[deprecated(since = "1.13.0", note = "use `std::hash::DefaultHasher` instead")]
4848
#[derive(Debug, Clone, Default)]
4949
pub struct SipHasher(SipHasher24);
5050

@@ -147,10 +147,7 @@ impl SipHasher {
147147
/// Creates a new `SipHasher` with the two initial keys set to 0.
148148
#[inline]
149149
#[stable(feature = "rust1", since = "1.0.0")]
150-
#[deprecated(
151-
since = "1.13.0",
152-
note = "use `std::collections::hash_map::DefaultHasher` instead"
153-
)]
150+
#[deprecated(since = "1.13.0", note = "use `std::hash::DefaultHasher` instead")]
154151
#[rustc_const_unstable(feature = "const_hash", issue = "104061")]
155152
#[must_use]
156153
pub const fn new() -> SipHasher {
@@ -160,10 +157,7 @@ impl SipHasher {
160157
/// Creates a `SipHasher` that is keyed off the provided keys.
161158
#[inline]
162159
#[stable(feature = "rust1", since = "1.0.0")]
163-
#[deprecated(
164-
since = "1.13.0",
165-
note = "use `std::collections::hash_map::DefaultHasher` instead"
166-
)]
160+
#[deprecated(since = "1.13.0", note = "use `std::hash::DefaultHasher` instead")]
167161
#[rustc_const_unstable(feature = "const_hash", issue = "104061")]
168162
#[must_use]
169163
pub const fn new_with_keys(key0: u64, key1: u64) -> SipHasher {
@@ -175,10 +169,7 @@ impl SipHasher13 {
175169
/// Creates a new `SipHasher13` with the two initial keys set to 0.
176170
#[inline]
177171
#[unstable(feature = "hashmap_internals", issue = "none")]
178-
#[deprecated(
179-
since = "1.13.0",
180-
note = "use `std::collections::hash_map::DefaultHasher` instead"
181-
)]
172+
#[deprecated(since = "1.13.0", note = "use `std::hash::DefaultHasher` instead")]
182173
#[rustc_const_unstable(feature = "const_hash", issue = "104061")]
183174
pub const fn new() -> SipHasher13 {
184175
SipHasher13::new_with_keys(0, 0)
@@ -187,10 +178,7 @@ impl SipHasher13 {
187178
/// Creates a `SipHasher13` that is keyed off the provided keys.
188179
#[inline]
189180
#[unstable(feature = "hashmap_internals", issue = "none")]
190-
#[deprecated(
191-
since = "1.13.0",
192-
note = "use `std::collections::hash_map::DefaultHasher` instead"
193-
)]
181+
#[deprecated(since = "1.13.0", note = "use `std::hash::DefaultHasher` instead")]
194182
#[rustc_const_unstable(feature = "const_hash", issue = "104061")]
195183
pub const fn new_with_keys(key0: u64, key1: u64) -> SipHasher13 {
196184
SipHasher13 { hasher: Hasher::new_with_keys(key0, key1) }

‎library/core/src/ptr/mod.rs

+1-2
Original file line numberDiff line numberDiff line change
@@ -1921,8 +1921,7 @@ pub fn addr_eq<T: ?Sized, U: ?Sized>(p: *const T, q: *const U) -> bool {
19211921
/// # Examples
19221922
///
19231923
/// ```
1924-
/// use std::collections::hash_map::DefaultHasher;
1925-
/// use std::hash::{Hash, Hasher};
1924+
/// use std::hash::{DefaultHasher, Hash, Hasher};
19261925
/// use std::ptr;
19271926
///
19281927
/// let five = 5;

‎library/core/tests/hash/mod.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ fn test_indirect_hasher() {
167167

168168
#[test]
169169
fn test_build_hasher_object_safe() {
170-
use std::collections::hash_map::{DefaultHasher, RandomState};
170+
use std::hash::{DefaultHasher, RandomState};
171171

172172
let _: &dyn BuildHasher<Hasher = DefaultHasher> = &RandomState::new();
173173
}

‎library/core/tests/lib.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ mod waker;
169169
#[allow(dead_code)] // Not used in all configurations.
170170
pub(crate) fn test_rng() -> rand_xorshift::XorShiftRng {
171171
use core::hash::{BuildHasher, Hash, Hasher};
172-
let mut hasher = std::collections::hash_map::RandomState::new().build_hasher();
172+
let mut hasher = std::hash::RandomState::new().build_hasher();
173173
core::panic::Location::caller().hash(&mut hasher);
174174
let hc64 = hasher.finish();
175175
let seed_vec = hc64.to_le_bytes().into_iter().chain(0u8..8).collect::<Vec<u8>>();

0 commit comments

Comments
 (0)