diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 13 |
1 files changed, 3 insertions, 10 deletions
@@ -24,19 +24,13 @@ block-urn-to-reference The eris-encode (INPUT BLOCK-SIZE OUTPUT-FUNCTION &KEY SECRET HASH-OUTPUT) -function can be used to encode a vector or a stream into an ERIS -read-capability. +function can be used to encode a vector, stream or pathname into an ERIS +read-capability. The eris-decode (READ-CAPABILITY FETCH-FUNCTION &KEY (CACHE-CAPACITY 2048)) function can be used to decode an ERIS read-capability. It returns a stream of the class ERIS-DECODE-STREAM: this class implements the Gray streams protocol. -In addition, on POSIX systems, eris-decode-parallel (READ-CAPABILITY -FETCH-FUNCTION OUTPUT-FILE &KEY (CACHE-CAPACITY 4096) (THREADS 4) -(INITIAL-BINDINGS *DEFAULT-SPECIAL-BINDINGS*)) function is available. This -function will attempt to decode an ERIS read-capability in parallel into a file -specified by the OUTPUT-FILE string or pathspec. - See the docstrings of the specific functions for more details. However, you should only use these to write custom backends; otherwise, see below.. @@ -48,8 +42,7 @@ fetch-function, caching details, block-size, etc. and the {en/de}coding functions simply take the backend as an argument. This interface consists of two generic functions: store-data, for encoding data, -and fetch-read-capability, for retrieving the contents of a read-capability -object. +and fetch-data, for retrieving the contents from a read-capability object. As an example, a file-based backend called file-backend is provided. It can be used simply by making an instance of the 'file-backend class with a :directory |