Module crypto/digest
The streaming Digest trait — one interface over Sha256 / Sha512 /
Sha1 / Md5 (plans/archive/STD_API_AUDIT.md §7 P0 item 7).
The trait speaks ArrayList(u8) for the digest so one type covers every
algorithm (the per-type inherent finish() keeps its fixed-size
Array(u8, N) for callers that want it). new and the sizes are
statics/constants of the implementor, which is what lets generic code —
hmac (std/crypto/hmac.yo) is the flagship — construct and drive any
hasher through a where(D <: Digest) bound.
Stability
unstable — the trait works and is exercised generically
(tests/crypto/digest.test.yo hashes through a where(D <: Digest)
bound and checks digest_size / block_size), but it is deliberately
the minimum HMAC needed. update lends the hasher (&mut Self) and
finish_bytes consumes it, as RustCrypto's Digest::finalize(self)
does, so "finalise exactly once" is enforced: a second finish is a use
after move (E0901). There is no reset: generic code builds a new
hasher per message. Adding a method with a default (as finish_hex
already is) stays additive; adding a required one does not.
Traits / Modules
The streaming-hash interface: new, update, finish_bytes, plus the
two sizes HMAC needs — RustCrypto's Digest trait, cut down to what
std/crypto actually uses.
Implemented by Sha256, Sha512, Sha1 and Md5, and open to a user
type. It exists so hmac can be written once over any hasher: new
and the sizes are statics of the implementor, so a where(D <: Digest)
function can CONSTRUCT a hasher it was never handed, which a
method-only trait could not.
The digest crosses the trait boundary as an ArrayList(u8) — one type
for every algorithm — where each implementor's inherent finish()
returns a fixed-size Array(u8, N). Prefer the inherent one when the
algorithm is known at the call site; it does not allocate.
update writes the hasher in place (mut(h) := D.new(); D.update(&mut h, &data);) and finish_bytes consumes it: one hasher,
one message.
Methods
new : fn() -> SelfA fresh hasher.
Returns: Self
update : fn(self : &mut Self, data : &ArrayList(u8)) -> unitdigest_size : fn() -> usizeThe digest length in bytes (32/64/20/16).
Returns: usize
block_size : fn() -> usizeThe compression block size in bytes (64, or 128 for SHA-512) — what HMAC pads keys to.
Returns: usize
finish_bytes : fn(self : Self) -> ArrayList(u8)Finalise, consuming the hasher, and return the digest as bytes.
Parameters
| Name | Type | Notes |
|---|---|---|
self | Self |
Returns: ArrayList(u8)
finish_hex : fn(self : Self) -> StringFinalise, consuming the hasher, and return the lowercase hex digest.
Parameters
| Name | Type | Notes |
|---|---|---|
self | Self |
Returns: String