diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 36 |
1 files changed, 31 insertions, 5 deletions
@@ -5,13 +5,39 @@ the specification. The code is licensed under the LGPLv3 or any later version, unless specified otherwise in a file. -Depends on Alexandria, Ironclad version 0.58+, function-cache, and fiveam for -the tests. +Depends on Alexandria, Ironclad version 0.58+, function-cache, +trivial-gray-streams, bordeaux-threads, and fiveam for testing. In addition, on +POSIX systems the mmap and osicat libraries are used for the parallel decoder. Until the Ironclad library released version 0.58, you have to use the master branch as it contains the necessary patch to add the RFC Chacha variant to Ironclad. -TODO: -+ fix the bugs -+ clean up the code
\ No newline at end of file + +The public API is exported by the ERIS package. + +There are the following functions for converting to and from ERIS +representations to eris-cl objects: + +read-capability-to-urn +urn-to-read-capability +octets-to-read-capability +read-capability-to-octets +reference-to-block-urn +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. + +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. |