lz4

2.6.1+incompatible Opens a new window with list of versions in this module.

LZ4 compression and decompression in pure Go For more information about how to use this package see README

Latest version published 3 years ago

GitHub

Package Health Score

67 / 100

security
No known security issues
popularity
Popular
maintenance
Inactive
community
Active

Popularity

Popular

Imported By: 715
GitHub Stars: 829
Forks: 139
Contributors: 40

Usage Popularity

Based on project statistics from the GitHub repository for the Golang package lz4, we found that it has been 829 times.

The popularity score for Golang modules is calculated based on the number of stars that the project has on GitHub as well as the number of imports by other modules.

Security

No known security issues

Security risks

Direct Vulnerabilities: 0
C
0
H
0
M
0
L

Indirect Vulnerabilities: Check with Snyk

Release Date

Jun 3, 2021

License

BSD-3-Clause

Security Policy

We found a way for you to contribute to the project! Looks like lz4 is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Inactive

Commit Frequency

Open Issues: 16
Open PR: 1
Last Release: 3 years ago
Last Commit: 4 months ago

Further analysis of the maintenance status of github.com/pierrec/lz4 based on released golang versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for github.com/pierrec/lz4 is that it hasn't seen any new versions released to golang in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Community

Active

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 40
Funding: No

With more than 10 contributors for the github.com/pierrec/lz4 repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like github.com/pierrec/lz4 is missing a Code of Conduct.

Embed Package Health Score Badge

Keep your project healthy

Check your go.mod

Ensure all the packages you're using are healthy and well-maintained

Readme

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

Subcommands:
Compress the given files or from stdin to stdout.
compress [arguments] [ ...]
  -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] [ ...]

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 @greatroar for his work on the asm implementations of the decoder for amd64 and arm64.

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

FAQs

What is lz4?

LZ4 compression and decompression in pure Go. Visit Snyk Advisor to see a full health score report for lz4, including popularity, security, maintenance & community analysis.

Is lz4 popular?

The golang package lz4 receives a total of ? weekly downloads. As such, lz4 popularity was classified as a popular. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is lz4 well maintained?

We found indications that lz4 is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is lz4 safe to use?

The golang package lz4 was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 23 April-2024, at 02:43 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP