lz4

README

go-lz4

go-lz4 is port of LZ4 lossless compression algorithm to Go. The original C code is located at:

https://github.com/Cyan4973/lz4

Status

Usage

go get github.com/bkaradzic/go-lz4

import "github.com/bkaradzic/go-lz4"

The package name is lz4

Notes

• go-lz4 saves a uint32 with the original uncompressed length at the beginning of the encoded buffer. They may get in the way of interoperability with other implementations.

Contributors

Damian Gryski (@dgryski)
Dustin Sallings (@dustin)

Contact

@bkaradzic
http://www.stuckingeometry.com

Project page
https://github.com/bkaradzic/go-lz4

License

Copyright 2011-2012 Branimir Karadzic. All rights reserved.
Copyright 2013 Damian Gryski. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY COPYRIGHT HOLDER ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Documentation

Index

• Constants
• Variables
• func CompressBound(isize int) int
• func Decode(dst, src []byte) ([]byte, error)
• func Encode(dst, src []byte) ([]byte, error)

Constants

const (

	// MaxInputSize is the largest buffer than can be compressed in a single block
	MaxInputSize = 0x7E000000
)

Variables

var (
	// ErrCorrupt indicates the input was corrupt
	ErrCorrupt = errors.New("corrupt input")
)

var (
	// ErrTooLarge indicates the input buffer was too large
	ErrTooLarge = errors.New("input too large")
)

Functions

func CompressBound

func CompressBound(isize int) int

CompressBound returns the maximum length of a lz4 block, given it's uncompressed length

func Decode

func Decode(dst, src []byte) ([]byte, error)

Decode returns the decoded form of src. The returned slice may be a subslice of dst if it was large enough to hold the entire decoded block.

func Encode

func Encode(dst, src []byte) ([]byte, error)

Encode returns the encoded form of src. The returned array may be a sub-slice of dst if it was large enough to hold the entire output.