gitea/vendor/github.com/pierrec/lz4/v4
6543 fae07cbc8f
Update Vendor (#16325)
* Add Dependencie Update Script

* update gitea.com/lunny/levelqueue

* update github.com/PuerkitoBio/goquery

* update github.com/alecthomas/chroma

* update github.com/blevesearch/bleve/v2

* update github.com/caddyserver/certmagic

* update github.com/go-enry/go-enry/v2

* update github.com/go-redis/redis/v8

* update github.com/hashicorp/golang-lru

* update github.com/klauspost/compress

* update github.com/markbates/goth

* update github.com/mholt/archiver/v3

* update github.com/microcosm-cc/bluemonday

* update github.com/minio/minio-go/v7

* update github.com/olivere/elastic/v7

* update github.com/xanzy/go-gitlab

* update github.com/yuin/goldmark
2021-07-04 04:06:10 +02:00
..
internal Update Vendor (#16325) 2021-07-04 04:06:10 +02:00
.gitignore go1.16 (#14783) 2021-02-28 18:08:33 -05:00
LICENSE Vendor Update Go Libs (#13444) 2020-11-06 13:41:42 -05:00
README.md go1.16 (#14783) 2021-02-28 18:08:33 -05:00
go.mod Vendor Update Go Libs (#13444) 2020-11-06 13:41:42 -05:00
go.sum go1.16 (#14783) 2021-02-28 18:08:33 -05:00
lz4.go Vendor Update (#16121) 2021-06-10 16:44:25 +02:00
options.go Vendor Update (#16121) 2021-06-10 16:44:25 +02:00
options_gen.go Vendor Update Go Libs (#13444) 2020-11-06 13:41:42 -05:00
reader.go Vendor Update (#16121) 2021-06-10 16:44:25 +02:00
state.go Vendor Update Go Libs (#13444) 2020-11-06 13:41:42 -05:00
state_gen.go Vendor Update Go Libs (#13444) 2020-11-06 13:41:42 -05:00
writer.go Vendor Update (#16121) 2021-06-10 16:44:25 +02:00

README.md

lz4 : LZ4 compression in pure Go

Go Reference CI 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/v4

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

go install github.com/pierrec/lz4/v4/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.