diff options
| author | Piotr Szarmanski | 2022-09-25 20:20:59 +0200 |
|---|---|---|
| committer | Piotr Szarmanski | 2022-09-25 20:20:59 +0200 |
| commit | e612b3d6658489fed51d6bc9a3c5c09cb60f4b74 (patch) | |
| tree | e8ff57bdcaa5a5d5ea6e617f5fcf2c40ae82854f /src/eris-decode.lisp | |
| parent | 8db501749d47964b436bc63cafb80a17bfd42396 (diff) | |
Fix documentation.
Diffstat (limited to 'src/eris-decode.lisp')
| -rw-r--r-- | src/eris-decode.lisp | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/src/eris-decode.lisp b/src/eris-decode.lisp index 351da72..508dc67 100644 --- a/src/eris-decode.lisp +++ b/src/eris-decode.lisp @@ -209,12 +209,13 @@ it is necessary and sets the position in the buffer to 0." (defun eris-decode (read-capability fetch-function &key (cache-capacity 2048)) "Using the FETCH-FUNCTION, return a stream that decodes the READ-CAPABILITY. +This stream implements the Gray streams protocol. Fetch-function must be a function with one argument, the reference octet, which returns a (simple-array (unsigned-byte 8)) containing the block. The block will be destructively modified, so you MUST provide a fresh array every time. If a hash-table is used, a (copy-seq) needs to be done on the return value of -gethash. +gethash. The keyword argument CACHE-CAPACITY indicates the amount of blocks stored in the cache." |