lz4

  1. lz4
    1. Description
    2. Author
    3. Documentation
    4. Error reporting
    5. License

Description

A small FFI wrapper around the LZ4 compression library. This egg includes its own version of the lz4 library.

Author

Yann Collet, wrapped up for CHICKEN by Christian Kellermann

Documentation

[procedure] (compress s8vector)

Calls the LZ4_compress C function. Returns a S8-Vector containing the compressed data in LZ4 Format.

[procedure] (compress-hc s8vector)

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.

[procedure] (uncompress s8vector)

Calls the LZ4_uncompress C function. Returns a S8-Vector containing the uncompressed data.

Error reporting

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 arguments, location and message.

License

 LZ4 Library
 Copyright (c) 2011-2014, Yann Collet
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification,
 are permitted provided that the following conditions are met:
 
 * Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.
 
 * Redistributions in binary form must reproduce the above copyright notice, this
   list of conditions and the following disclaimer in the documentation and/or
   other materials provided with the distribution.
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.