tree: d82ec4cdc0e804680cd7ca0e3328ad533aa8cbd4 [path history] [tgz]
  1. .gitignore
  2. .travis.yml
  5. block.go
  6. debug.go
  7. debug_stub.go
  8. decode_amd64.go
  9. decode_amd64.s
  10. decode_other.go
  11. errors.go
  12. go.mod
  13. go.sum
  14. internal/
  15. lz4.go
  16. lz4_go1.10.go
  17. lz4_notgo1.10.go
  18. reader.go
  19. writer.go

lz4 : LZ4 compression in pure Go

GoDoc Build Status Go Report Card GitHub tag (latest SemVer)


This package provides a streaming interface to LZ4 data streams as well as low level compress and uncompress functions for LZ4 data blocks. The implementation is based on the reference C one.


Assuming you have the go toolchain installed:

go get

There is a command line interface tool to compress and decompress LZ4 files.

go install


Usage of lz4c:
        print the program version

Compress the given files or from stdin to stdout.
compress [arguments] [<file name> ...]
        enable block checksum
  -l int
        compression level (0=fastest)
        disable stream checksum
  -size string
        block max size [64K,256K,1M,4M] (default "4M")

Uncompress the given files or from stdin to stdout.
uncompress [arguments] [<file name> ...]


// Compress and uncompress an input string.
s := "hello world"
r := strings.NewReader(s)

// The pipe will uncompress the data from the writer.
pr, pw := io.Pipe()
zw := lz4.NewWriter(pw)
zr := lz4.NewReader(pr)

go func() {
	// Compress the input string.
	_, _ = io.Copy(zw, r)
	_ = zw.Close() // Make sure the writer is closed
	_ = pw.Close() // Terminate the pipe

_, _ = io.Copy(os.Stdout, zr)

// Output:
// hello world


Contributions are very welcome for bug fixing, performance improvements...!

  • Open an issue with a proper description
  • Send a pull request with appropriate test case(s)


Thanks to all contributors so far:

Special thanks to @Zariel for his asm implementation of the decoder