gitea-1156/vendor/github.com/pierrec/lz4/v3
6543 12a1f914f4
Vendor Update Go Libs (#13166)
* update github.com/alecthomas/chroma v0.8.0 -> v0.8.1

* github.com/blevesearch/bleve v1.0.10 -> v1.0.12

* editorconfig-core-go v2.1.1 -> v2.3.7

* github.com/gliderlabs/ssh v0.2.2 -> v0.3.1

* migrate editorconfig.ParseBytes to Parse

* github.com/shurcooL/vfsgen to 0d455de96546

* github.com/go-git/go-git/v5 v5.1.0 -> v5.2.0

* github.com/google/uuid v1.1.1 -> v1.1.2

* github.com/huandu/xstrings v1.3.0 -> v1.3.2

* github.com/klauspost/compress v1.10.11 -> v1.11.1

* github.com/markbates/goth v1.61.2 -> v1.65.0

* github.com/mattn/go-sqlite3 v1.14.0 -> v1.14.4

* github.com/mholt/archiver v3.3.0 -> v3.3.2

* github.com/microcosm-cc/bluemonday 4f7140c49acb -> v1.0.4

* github.com/minio/minio-go v7.0.4 -> v7.0.5

* github.com/olivere/elastic v7.0.9 -> v7.0.20

* github.com/urfave/cli v1.20.0 -> v1.22.4

* github.com/prometheus/client_golang v1.1.0 -> v1.8.0

* github.com/xanzy/go-gitlab v0.37.0 -> v0.38.1

* mvdan.cc/xurls v2.1.0 -> v2.2.0

Co-authored-by: Lauris BH <lauris@nix.lv>
2020-10-16 01:06:27 -04:00
..
internal/xxh32 Vendor Update Go Libs (#13166) 2020-10-16 01:06:27 -04:00
.gitignore Vendor Update Go Libs (#13166) 2020-10-16 01:06:27 -04:00
.travis.yml Vendor Update Go Libs (#13166) 2020-10-16 01:06:27 -04:00
LICENSE Vendor Update Go Libs (#13166) 2020-10-16 01:06:27 -04:00
README.md Vendor Update Go Libs (#13166) 2020-10-16 01:06:27 -04:00
block.go Vendor Update Go Libs (#13166) 2020-10-16 01:06:27 -04:00
debug.go Vendor Update Go Libs (#13166) 2020-10-16 01:06:27 -04:00
debug_stub.go Vendor Update Go Libs (#13166) 2020-10-16 01:06:27 -04:00
decode_amd64.go Vendor Update Go Libs (#13166) 2020-10-16 01:06:27 -04:00
decode_amd64.s Vendor Update Go Libs (#13166) 2020-10-16 01:06:27 -04:00
decode_other.go Vendor Update Go Libs (#13166) 2020-10-16 01:06:27 -04:00
errors.go Vendor Update Go Libs (#13166) 2020-10-16 01:06:27 -04:00
go.mod Vendor Update Go Libs (#13166) 2020-10-16 01:06:27 -04:00
go.sum Vendor Update Go Libs (#13166) 2020-10-16 01:06:27 -04:00
lz4.go Vendor Update Go Libs (#13166) 2020-10-16 01:06:27 -04:00
lz4_go1.10.go Vendor Update Go Libs (#13166) 2020-10-16 01:06:27 -04:00
lz4_notgo1.10.go Vendor Update Go Libs (#13166) 2020-10-16 01:06:27 -04:00
reader.go Vendor Update Go Libs (#13166) 2020-10-16 01:06:27 -04:00
writer.go Vendor Update Go Libs (#13166) 2020-10-16 01:06:27 -04:00

README.md

lz4 : LZ4 compression in pure Go

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

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

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.

Special thanks to @klauspost for his work on optimizing the code.