-
Notifications
You must be signed in to change notification settings - Fork 13.3k
Clarify documentation of hash::SipHasher #32091
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
bors
merged 3 commits into
rust-lang:master
from
dirk:dirk/siphasher-docs-clarification
Mar 10, 2016
Merged
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -19,15 +19,17 @@ use super::Hasher; | |
/// | ||
/// See: http://131002.net/siphash/ | ||
/// | ||
/// Consider this as a main "general-purpose" hash for all hashtables: it | ||
/// runs at good speed (competitive with spooky and city) and permits | ||
/// strong _keyed_ hashing. Key your hashtables from a strong RNG, | ||
/// such as `rand::Rng`. | ||
/// This is the default hashing function used by standard library (eg. | ||
/// `collections::HashMap` uses it by default). | ||
/// | ||
/// Although the SipHash algorithm is considered to be cryptographically | ||
/// strong, this implementation has not been reviewed for such purposes. | ||
/// As such, all cryptographic uses of this implementation are strongly | ||
/// discouraged. | ||
/// 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::Rng`](https://doc.rust-lang.org/rand/rand/trait.Rng.html). | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Unfortunately all implementors of |
||
/// | ||
/// 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_. | ||
#[stable(feature = "rust1", since = "1.0.0")] | ||
pub struct SipHasher { | ||
k0: u64, | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perhaps this could say "this is currently the default" to emphasize that it may change over time?