mirror of
https://github.com/ddidderr/wuffs.git
synced 2026-11-18 00:32:11 +01:00
Add doc/std/hashers.md
This commit is contained in:
1 parent
8ff9cdb9a6
commit
a96756bd09
1 file changed
+27
@@ -0,0 +1,27 @@
|
||||
# Hashers
|
||||
|
||||
Hashers take a stream of bytes (of arbitrary length) and produce a fixed length
|
||||
value - the hash. For example, the CRC-32/IEEE hashing algorithm produces a 32
|
||||
bit value (a `base.u32`). The MD5 hashing algorithm produces a 128 bit value.
|
||||
|
||||
Wuffs' hasher implementations have only one method. For 32 bit hashes, the
|
||||
method signature is `update_u32!(x: slice base.u8) base.u32`. It incrementally
|
||||
updates the hasher object's state with the addition data `x`, and returns the
|
||||
hash value so far, for all of the data up to and including `x`.
|
||||
|
||||
This method is stateful. Calling `update_u32` twice with the same slice of
|
||||
bytes can produce two different hash values. Conversely, calling `update_u32`
|
||||
twice with two different slices should be equivalent to calling it once on
|
||||
their concatenation. [Re-initialize](/doc/note/initialization.md) the object to
|
||||
reset the state.
|
||||
|
||||
|
||||
## Implementations
|
||||
|
||||
- [std/adler32](/std/adler32)
|
||||
- [std/crc32](/std/crc32)
|
||||
|
||||
|
||||
## Examples
|
||||
|
||||
- [example/crc32](/example/crc32)
|
||||
Reference in new issue
Block a user