((section 2 "Outdated egg!" (p "This is an egg for CHICKEN 4, the unsupported old release.  You're almost certainly looking for " (int-link "/eggref/5/lz4" "the CHICKEN 5 version of this egg") ", if it exists.") (p "If it does not exist, there may be equivalent functionality provided by another egg; have a look at the " (link "https://wiki.call-cc.org/chicken-projects/egg-index-5.html" "egg index") ". Otherwise, please consider porting this egg to the current version of CHICKEN.") (tags "egg")) (section 2 "lz4" (toc) (section 3 "Description" (p "A small FFI wrapper around the " (link "https://code.google.com/p/lz4/" "LZ4") " compression library. This egg includes its own version of the lz4 library.")) (section 3 "Author" (p "Yann Collet, wrapped up for CHICKEN by " (int-link "/users/christian-kellermann" "Christian Kellermann"))) (section 3 "Documentation" (def (sig (procedure "(compress s8vector)" (id compress))) (p "Calls the LZ4_compress C function. Returns a S8-Vector containing the compressed data in LZ4 Format.")) (def (sig (procedure "(compress-hc s8vector)" (id compress-hc))) (p "Calls the LZ4_compressHC C function. Returns a S8-Vector containing the compressed data in LZ4 Format. This procedure uses the high compression variant of LZ4.")) (def (sig (procedure "(uncompress s8vector)" (id uncompress))) (p "Calls the LZ4_uncompress C function. Returns a S8-Vector containing the uncompressed data."))) (section 3 "Error reporting" (p "All of the above procedures may raise a composite condition of the form (exn ffi lz4) indicating the source and reason of the error in the exn properties " (i "arguments") ", " (i "location") " and " (i "message") ".")) (section 3 "License" (pre " LZ4 Library\n Copyright (c) 2011-2014, Yann Collet\n All rights reserved.\n \n Redistribution and use in source and binary forms, with or without modification,\n are permitted provided that the following conditions are met:\n \n * Redistributions of source code must retain the above copyright notice, this\n   list of conditions and the following disclaimer.\n \n * Redistributions in binary form must reproduce the above copyright notice, this\n   list of conditions and the following disclaimer in the documentation and/or\n   other materials provided with the distribution.\n \n THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND\n ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED\n WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\n DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR\n ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES\n (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;\n LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON\n ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\n (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS\n SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."))))