core::hash::BuildHasher - Rust
Description: API documentation for the Rust `BuildHasher` trait in crate `core`.
Keywords: rust, rustlang, rust-lang, BuildHasher

# Trait core::hash::BuildHasher 1.7.0 [−] [src]

    pub trait BuildHasher {
        type Hasher: Hasher;
        fn build_hasher(&self) -> Self::Hasher;
    }

A trait for creating instances of `Hasher`.

A `BuildHasher` is typically used (e.g. by `HashMap`) to create `Hasher`s for each key such that they are hashed independently of one another, since `Hasher`s contain state.

For each instance of `BuildHasher`, the `Hasher`s created by `build_hasher` should be identical. That is, if the same stream of bytes is fed into each hasher, the same output will also be generated.

# Examples

    use std::collections::hash_map::RandomState;
    use std::hash::{BuildHasher, Hasher};

    let s = RandomState::new();
    let mut hasher_1 = s.build_hasher();
    let mut hasher_2 = s.build_hasher();

    hasher_1.write_u32(8128);
    hasher_2.write_u32(8128);

    assert_eq!(hasher_1.finish(), hasher_2.finish());Run

## Associated Types

### `type Hasher: Hasher`

Type of the hasher that will be created.

## Required Methods

### `fn build_hasher(&self) -> Self::Hasher`

Creates a new hasher.

Each call to `build_hasher` on the same instance should produce identical `Hasher`s.

# Examples

    use std::collections::hash_map::RandomState;
    use std::hash::BuildHasher;

    let s = RandomState::new();
    let new_s = s.build_hasher();Run

## Implementors

- `impl<H: Default + Hasher> BuildHasher for BuildHasherDefault<H> type Hasher = H;`

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result
+
  Collapse/expand all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)