Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 374 Commits
.github/workflows		.github/workflows
cmd/lz4c		cmd/lz4c
fuzz		fuzz
internal		internal
testdata		testdata
.gitignore		.gitignore
LICENSE		LICENSE
README.md		README.md
bench_test.go		bench_test.go
compressing_reader.go		compressing_reader.go
compressing_reader_test.go		compressing_reader_test.go
example_test.go		example_test.go
go.mod		go.mod
go.sum		go.sum
lz4.go		lz4.go
options.go		options.go
options_gen.go		options_gen.go
reader.go		reader.go
reader_test.go		reader_test.go
state.go		state.go
state_gen.go		state_gen.go
writer.go		writer.go
writer_test.go		writer_test.go

Repository files navigation

lz4 : LZ4 compression in pure Go

Overview

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

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@latest

Usage

Usage of lz4c:  -version        print the program versionSubcommands: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