Crate digest

This crate provides traits which describe functionality of cryptographic hash functions.

Traits in this repository are organized into high-level convenience traits, mid-level traits which expose more fine-grained functionality, and low-level traits intended to only be used by algorithm implementations:

• High-level convenience traits: Digest, DynDigest. They are wrappers around lower-level traits for most common hash-function use-cases.
• Mid-level traits: Update, BlockInput, Reset, FixedOutput, VariableOutput, ExtendableOutput. These traits atomically describe available functionality of hash function implementations.
• Low-level traits: FixedOutputDirty, VariableOutputDirty, ExtendableOutputDirty. These traits are intended to be implemented by low-level algorithm providers only and simplify the amount of work implementers need to do and therefore shouldn't be used in application-level code.

Additionally hash functions implement traits from the standard library: Default, Clone, Write. The latter is feature-gated behind std feature, which is usually enabled by default by hash implementation crates.

The Digest trait is the most commonly used trait.

Re-exports

pub use generic_array;

Modules

consts	Type aliases for many constants.
dev	feature="dev" Development-related functionality

Macros

bench	feature="dev" Define benchmark
impl_write	Implements std::io::Write trait for implementer of Update
new_test	feature="dev" Define test

Structs

InvalidOutputSize

The error type for variable hasher initialization

Traits

BlockInput	Trait to indicate that digest function processes data in blocks of size BlockSize.
Digest	The Digest trait specifies an interface common for digest functions.
DynDigest	feature="alloc" The DynDigest trait is a modification of Digest trait suitable for trait objects.
ExtendableOutput	Trait which describes extendable-output functions (XOF).
ExtendableOutputDirty	Trait for extendable-output function (XOF) implementations to use to retrieve the hash output.
FixedOutput	Trait for returning digest result with the fixed size
FixedOutputDirty	Trait for fixed-output digest implementations to use to retrieve the hash output.
Reset	Trait for resetting hash instances
Update	Trait for updating digest state with input data.
VariableOutput	Trait for returning digest result with the variable size
VariableOutputDirty	Trait for variable-sized output digest implementations to use to retrieve the hash output.
XofReader	Trait for describing readers which are used to extract extendable output from XOF (extendable-output function) result.

Type Definitions

Output

Output of a Digest function