Skip to content

Commit

Permalink
Update flag documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
AaronFeickert committed Jul 5, 2024
1 parent 81672a3 commit a4e2df8
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions src/hashing.rs
Original file line number Diff line number Diff line change
Expand Up @@ -56,15 +56,17 @@ use crate::{
/// - If the input is of variable length (determined by the type), a little-endian 64-bit encoding of the length
/// - The input, encoded as bytes
/// By doing so, we mitigate the risk of collision.
///
/// These are not exposed to the user; they are used internally only.
#[repr(u8)]
enum Flag {
/// An initial domain separator indicating the purpose of the hasher
/// An initial domain separator indicating the general purpose of the hasher
DomainSeparator = 0,
/// The version of the hasher, which MUST be a single byte
Version,
/// A label that can be used to differentiate uses of the hasher
/// A label that can be used to differentiate specific uses of the hasher
Label,
/// Arbitrary byte data to be added to the hasher
/// Arbitrary byte data to be added to the hasher, such as via `update` or `chain`
Data,
}

Expand Down

0 comments on commit a4e2df8

Please sign in to comment.