aboutsummaryrefslogtreecommitdiff
path: root/c/README.md
diff options
context:
space:
mode:
authorJack O'Connor <[email protected]>2022-01-07 15:51:35 -0500
committerJack O'Connor <[email protected]>2022-01-07 15:51:35 -0500
commit7d8c00507142b3716d0f606ab4e169e0936316a6 (patch)
tree56968b35dad743b982b839fc8acf474c1dd84d2d /c/README.md
parentc7b5881928715429857d0b3e1bee7a4315cbf415 (diff)
add blake3_hasher_reset to the C API
Diffstat (limited to 'c/README.md')
-rw-r--r--c/README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/c/README.md b/c/README.md
index e3fca0c..5e35fe0 100644
--- a/c/README.md
+++ b/c/README.md
@@ -185,6 +185,21 @@ parameter for the starting byte position in the output stream. To
efficiently stream a large output without allocating memory, call this
function in a loop, incrementing `seek` by the output length each time.
+---
+
+```c
+void blake3_hasher_reset(
+ blake3_hasher *self);
+```
+
+Reset the hasher to its initial state, prior to any calls to
+`blake3_hasher_update`. Currently this is no different from calling
+`blake3_hasher_init` or similar again. However, if this implementation gains
+multithreading support in the future, and if `blake3_hasher` holds (optional)
+threading resources, this function will reuse those resources. Until then, this
+is mainly for feature compatibility with the Rust implementation.
+
+
# Building
This implementation is just C and assembly files. It doesn't include a