lz4

Documentation

Index

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

Constants

const (

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

Variables

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

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

Functions

func CompressBound

func CompressBound(isize int) int

CompressBound returns the maximum length of a lz4 block

func Decode

func Decode(dst, src []byte) (int, 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) (compressedSize int, error 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.