steve
/
factor
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

checksums-docs: add note on using checksums.stream

char-rename
Alexander Iljin 2016-06-26 15:08:48 +03:00 committed by John Benediktsson
parent 0c56a7cec1
commit c054cb7a78
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
core/checksums/checksums-docs.factor
View File

@ -58,6 +58,9 @@ $nl
}
"Checksums should implement at least one of " { $link checksum-bytes } " and " { $link checksum-stream } ". Implementing " { $link checksum-lines } " is optional."
$nl
"In the default implementation " { $link checksum-bytes } " is abstract, and " { $link checksum-stream } " is implemented by calling it with the stream contents fully read into memory. If you want your checksum to be the other way around, that is, " { $link checksum-bytes } " to be implemented by calling " { $link checksum-stream } ", consider using the " { $snippet "stream-checksum" } " mixin:"
{ $vocab-subsection "stream-checksum" "checksums.stream" }
$nl
"Utilities:"
{ $subsections
checksum-file