Rollup merge of #43905 - partim:master, r=steveklabnik
Document that `std:#️⃣:Hasher::finish()` does not reset the hasher. Clarifies the fact that `finish()` doesn’t in fact end or reset the hasher. This was surprising to me … Follows up on and fixes #43763
This commit is contained in:
commit
1512e44c17
1 changed files with 8 additions and 1 deletions
|
@ -240,7 +240,12 @@ pub trait Hash {
|
||||||
/// [`write_u8`]: #method.write_u8
|
/// [`write_u8`]: #method.write_u8
|
||||||
#[stable(feature = "rust1", since = "1.0.0")]
|
#[stable(feature = "rust1", since = "1.0.0")]
|
||||||
pub trait Hasher {
|
pub trait Hasher {
|
||||||
/// Completes a round of hashing, producing the output hash generated.
|
/// Returns the hash value for the values written so far.
|
||||||
|
///
|
||||||
|
/// Despite its name, the method does not reset the hasher’s internal
|
||||||
|
/// state. Additional [`write`]s will continue from the current value.
|
||||||
|
/// If you need to start a fresh hash value, you will have to create
|
||||||
|
/// a new hasher.
|
||||||
///
|
///
|
||||||
/// # Examples
|
/// # Examples
|
||||||
///
|
///
|
||||||
|
@ -253,6 +258,8 @@ pub trait Hasher {
|
||||||
///
|
///
|
||||||
/// println!("Hash is {:x}!", hasher.finish());
|
/// println!("Hash is {:x}!", hasher.finish());
|
||||||
/// ```
|
/// ```
|
||||||
|
///
|
||||||
|
/// ['write']: #tymethod.write
|
||||||
#[stable(feature = "rust1", since = "1.0.0")]
|
#[stable(feature = "rust1", since = "1.0.0")]
|
||||||
fn finish(&self) -> u64;
|
fn finish(&self) -> u64;
|
||||||
|
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue