std::hash::SipHasher - Rust
Description: API documentation for the Rust `SipHasher` struct in crate `std`.
Keywords: rust, rustlang, rust-lang, SipHasher

# 1.0.0[−][src]Struct std::hash::SipHasher

    pub struct SipHasher(_);

Deprecated since 1.13.0

: use `std::collections::hash_map::DefaultHasher` instead

An implementation of SipHash 2-4.

See: https://131002.net/siphash/

SipHash is a general-purpose hashing function: it runs at a good speed (competitive with Spooky and City) and permits strong keyed hashing. This lets you key your hashtables from a strong RNG, such as `rand::os::OsRng`.

Although the SipHash algorithm is considered to be generally strong, it is not intended for cryptographic purposes. As such, all cryptographic uses of this implementation are strongly discouraged.

## Methods

###

`impl SipHasher`

[src]

####

`pub fn new() -> SipHasher`

[src]

Deprecated since 1.13.0

: use `std::collections::hash_map::DefaultHasher` instead

Creates a new `SipHasher` with the two initial keys set to 0.

####

`pub fn new_with_keys(key0: u64, key1: u64) -> SipHasher`

[src]

Deprecated since 1.13.0

: use `std::collections::hash_map::DefaultHasher` instead

Creates a `SipHasher` that is keyed off the provided keys.

## Trait Implementations

###

`impl Hasher for SipHasher`

[src]

####

`fn write(&mut self, msg: &[u8])`

[src]

Writes some data into this `Hasher`. Read more

####

`fn finish(&self) -> u64`

[src]

Returns the hash value for the values written so far. Read more

####

`fn write_u8(&mut self, i: u8)`

1.3.0
[src]

Writes a single `u8` into this hasher.

####

`fn write_u16(&mut self, i: u16)`

1.3.0
[src]

Writes a single `u16` into this hasher.

####

`fn write_u32(&mut self, i: u32)`

1.3.0
[src]

Writes a single `u32` into this hasher.

####

`fn write_u64(&mut self, i: u64)`

1.3.0
[src]

Writes a single `u64` into this hasher.

####

`fn write_u128(&mut self, i: u128)`

1.26.0
[src]

Writes a single `u128` into this hasher.

####

`fn write_usize(&mut self, i: usize)`

1.3.0
[src]

Writes a single `usize` into this hasher.

####

`fn write_i8(&mut self, i: i8)`

1.3.0
[src]

Writes a single `i8` into this hasher.

####

`fn write_i16(&mut self, i: i16)`

1.3.0
[src]

Writes a single `i16` into this hasher.

####

`fn write_i32(&mut self, i: i32)`

1.3.0
[src]

Writes a single `i32` into this hasher.

####

`fn write_i64(&mut self, i: i64)`

1.3.0
[src]

Writes a single `i64` into this hasher.

####

`fn write_i128(&mut self, i: i128)`

1.26.0
[src]

Writes a single `i128` into this hasher.

####

`fn write_isize(&mut self, i: isize)`

1.3.0
[src]

Writes a single `isize` into this hasher.

###

`impl Clone for SipHasher`

[src]

####

`fn clone(&self) -> SipHasher`

[src]

Returns a copy of the value. Read more

####

`fn clone_from(&mut self, source: &Self)`

[src]

Performs copy-assignment from `source`. Read more

###

`impl Debug for SipHasher`

[src]

####

`fn fmt(&self, f: &mut Formatter) -> Result<(), Error>`

[src]

Formats the value using the given formatter. Read more

###

`impl Default for SipHasher`

[src]

####

`fn default() -> SipHasher`

[src]

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

## Auto Trait Implementations

###

`impl Send for SipHasher`

###

`impl Sync for SipHasher`

## Blanket Implementations

###

`impl<T> From for T`

[src]

####

`fn from(t: T) -> T`

[src]

Performs the conversion.

###

`impl<T, U> TryFrom for T where T: From<U>,`

[src]

#### `type Error = !`

🔬 This is a nightly-only experimental API. (`try_from` #33417)

The type returned in the event of a conversion error.

####

`fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`

[src]

🔬 This is a nightly-only experimental API. (`try_from` #33417)

Performs the conversion.

###

`impl<T, U> TryInto for T where U: TryFrom<T>,`

[src]

#### `type Error = <U as TryFrom<T>>::Error`

🔬 This is a nightly-only experimental API. (`try_from` #33417)

The type returned in the event of a conversion error.

####

`fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`

[src]

🔬 This is a nightly-only experimental API. (`try_from` #33417)

Performs the conversion.

###

`impl<T, U> Into for T where U: From<T>,`

[src]

####

`fn into(self) -> U`

[src]

Performs the conversion.

###

`impl<T> Borrow for T where T: ?Sized,`

[src]

####
ⓘImportant traits for &'_ mut I

### Important traits for &'_ mut I

`impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'a, R: Read + ?Sized> Read for &'a mut Rimpl<'a, W: Write + ?Sized> Write for &'a mut W`

`fn borrow(&self) -> &T`

[src]

Immutably borrows from an owned value. Read more

###

`impl<T> BorrowMut for T where T: ?Sized,`

[src]

####
ⓘImportant traits for &'_ mut I

### Important traits for &'_ mut I

`impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'a, R: Read + ?Sized> Read for &'a mut Rimpl<'a, W: Write + ?Sized> Write for &'a mut W`

`fn borrow_mut(&mut self) -> &mut T`

[src]

Mutably borrows from an owned value. Read more

###

`impl<T> Any for T where T: 'static + ?Sized,`

[src]

####

`fn get_type_id(&self) -> TypeId`

[src]

🔬 This is a nightly-only experimental API. (`get_type_id` #27745)

this method will likely be replaced by an associated static

Gets the `TypeId` of `self`. Read more

###

`impl<T> ToOwned for T where T: Clone,`

[src]

#### `type Owned = T`

####

`fn to_owned(&self) -> T`

[src]

Creates owned data from borrowed data, usually by cloning. Read more

####

`fn clone_into(&self, target: &mut T)`

[src]

🔬 This is a nightly-only experimental API. (`toowned_clone_into` #41263)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse 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`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)