mirror
/
tile38
mirror of https://github.com/tidwall/tile38.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
tile38/vendor/github.com/pierrec/lz4
History
Josh Baker 26d0083faf Update vendoring to use golang/dep 
commit a1a37d335a8e89ac89d85c00c8585d3fc02e064a
Author: Josh Baker <joshbaker77@gmail.com>
Date:   Thu Oct 5 07:36:54 2017 -0700

    use symlink instead of copy

commit 96399c2c92620f633611c778e5473200bfd48d41
Author: Josh Baker <joshbaker77@gmail.com>
Date:   Thu Oct 5 07:19:26 2017 -0700

    use dep for vendoring
 		2017-10-05 07:40:19 -07:00
..
fuzz Update vendoring to use golang/dep 2017-10-05 07:40:19 -07:00
lz4c Update vendoring to use golang/dep 2017-10-05 07:40:19 -07:00
testdata Update vendoring to use golang/dep 2017-10-05 07:40:19 -07:00
.gitignore Update vendoring to use golang/dep 2017-10-05 07:40:19 -07:00
.travis.yml Update vendoring to use golang/dep 2017-10-05 07:40:19 -07:00
LICENSE Update vendoring to use golang/dep 2017-10-05 07:40:19 -07:00
README.md Update vendoring to use golang/dep 2017-10-05 07:40:19 -07:00
block.go Update vendoring to use golang/dep 2017-10-05 07:40:19 -07:00
export_test.go Update vendoring to use golang/dep 2017-10-05 07:40:19 -07:00
lz4.go Update vendoring to use golang/dep 2017-10-05 07:40:19 -07:00
lz4_test.go Update vendoring to use golang/dep 2017-10-05 07:40:19 -07:00
reader.go Update vendoring to use golang/dep 2017-10-05 07:40:19 -07:00
writer.go Update vendoring to use golang/dep 2017-10-05 07:40:19 -07:00

README.md

godoc Build Status

lz4

LZ4 compression and decompression in pure Go

Usage

import "github.com/pierrec/lz4"

Description

Package lz4 implements reading and writing lz4 compressed data (a frame), as specified in http://fastcompression.blogspot.fr/2013/04/lz4-streaming-format-final.html, using an io.Reader (decompression) and io.Writer (compression). It is designed to minimize memory usage while maximizing throughput by being able to [de]compress data concurrently.

The Reader and the Writer support concurrent processing provided the supplied buffers are large enough (in multiples of BlockMaxSize) and there is no block dependency. Reader.WriteTo and Writer.ReadFrom do leverage the concurrency transparently. The runtime.GOMAXPROCS() value is used to apply concurrency or not.

Although the block level compression and decompression functions are exposed and are fully compatible with the lz4 block format definition, they are low level and should not be used directly. For a complete description of an lz4 compressed block, see: http://fastcompression.blogspot.fr/2011/05/lz4-explained.html

See https://github.com/Cyan4973/lz4 for the reference C implementation.