Trait Digest

pub trait Digest:
    Input
    + BlockInput
    + FixedOutput
    + Default {
    // Provided methods
    fn new() -> Self { ... }
    fn input(&mut self, input: &[u8]) { ... }
    fn result(self) -> GenericArray<u8, Self::OutputSize> { ... }
    fn digest(data: &[u8]) -> GenericArray<u8, Self::OutputSize> { ... }
    fn digest_str(str: &str) -> GenericArray<u8, Self::OutputSize> { ... }
}

The Digest trait specifies an interface common for digest functions.

It’s a convinience wrapper around Input, FixedOutput, BlockInput and Default traits. It also provides additional convenience methods.

Provided Methods

fn new() -> Self

Create new hasher instance

fn input(&mut self, input: &[u8])

Digest input data. This method can be called repeatedly for use with streaming messages.

fn result(self) -> GenericArray<u8, Self::OutputSize>

Retrieve the digest result. This method consumes digest instance.

fn digest(data: &[u8]) -> GenericArray<u8, Self::OutputSize>

Convenience function to compute hash of the data. It will handle hasher creation, data feeding and finalization.

Example:

println!("{:x}", sha2::Sha256::digest(b"Hello world"));

fn digest_str(str: &str) -> GenericArray<u8, Self::OutputSize>

Convenience function to compute hash of the string. It’s equivalent to digest(input_string.as_bytes()).

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl<D> Digest for D

where D: Input + FixedOutput + BlockInput + Default,