History

Seth Hoenig 435c0d9fc8 deps: Switch to Go modules for dependency management This PR switches the Nomad repository from using govendor to Go modules for managing dependencies. Aspects of the Nomad workflow remain pretty much the same. The usual Makefile targets should continue to work as they always did. The API submodule simply defers to the parent Nomad version on the repository, keeping the semantics of API versioning that currently exists.		2020-06-02 14:30:36 -05:00
..
internal/xxh32	vendor: vault api and sdk	2020-03-21 17:57:48 +01:00
.gitignore	deps: Switch to Go modules for dependency management	2020-06-02 14:30:36 -05:00
.travis.yml	deps: Switch to Go modules for dependency management	2020-06-02 14:30:36 -05:00
LICENSE	vendor: vault api and sdk	2020-03-21 17:57:48 +01:00
README.md	deps: Switch to Go modules for dependency management	2020-06-02 14:30:36 -05:00
block.go	deps: Switch to Go modules for dependency management	2020-06-02 14:30:36 -05:00
debug.go	vendor: vault api and sdk	2020-03-21 17:57:48 +01:00
debug_stub.go	vendor: vault api and sdk	2020-03-21 17:57:48 +01:00
decode_amd64.go	vendor: vault api and sdk	2020-03-21 17:57:48 +01:00
decode_amd64.s	vendor: vault api and sdk	2020-03-21 17:57:48 +01:00
decode_other.go	deps: Switch to Go modules for dependency management	2020-06-02 14:30:36 -05:00
errors.go	deps: Switch to Go modules for dependency management	2020-06-02 14:30:36 -05:00
lz4.go	deps: Switch to Go modules for dependency management	2020-06-02 14:30:36 -05:00
lz4_go1.10.go	vendor: vault api and sdk	2020-03-21 17:57:48 +01:00
lz4_notgo1.10.go	vendor: vault api and sdk	2020-03-21 17:57:48 +01:00
reader.go	deps: Switch to Go modules for dependency management	2020-06-02 14:30:36 -05:00
writer.go	deps: Switch to Go modules for dependency management	2020-06-02 14:30:36 -05:00

README.md

lz4 : LZ4 compression in pure Go

Overview

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.

Install

Assuming you have the go toolchain installed:

go get github.com/pierrec/lz4

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

go install github.com/pierrec/lz4/cmd/lz4c

Usage

Usage of lz4c:
  -version
        print the program version

Subcommands:
Compress the given files or from stdin to stdout.
compress [arguments] [<file name> ...]
  -bc
        enable block checksum
  -l int
        compression level (0=fastest)
  -sc
        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> ...]

Example

// 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

Contributing

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)

Contributors

Thanks to all contributors so far:

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