compress

Documentation

Index

• Constants
• func Compress(algorithm Algorithm, in []byte, opts ...Options) (out []byte, err error)
• func Uncompress(algorithm Algorithm, in []byte, opts ...Options) (out []byte, err error)
• type Algorithm
• type Error
  • func (e Error) Error() string
• type Options

Constants

const (
	// ErrNotSupported indicates that given algorithm is not supported.
	ErrNotSupported = Error("not supported")
	// ErrNilInput indicates that given data is nil.
	ErrNilInput = Error("nil input")
)

const (
	// Gzip is gzip compression
	Gzip = Algorithm("gzip")
)

Functions

func Compress

func Compress(algorithm Algorithm, in []byte, opts ...Options) (out []byte, err error)

Compress compresses data with specified algorithm

func Uncompress

func Uncompress(algorithm Algorithm, in []byte, opts ...Options) (out []byte, err error)

Uncompress uncompress data with specified algorithm

Types

type Algorithm

type Algorithm string

Algorithm indicates suported Algorithms in this package

type Error

type Error string

Error is a inner error type

func (Error) Error

func (e Error) Error() string

type Options

type Options struct {
	Name    string
	Comment string
	MaxRead int
}

Options indicates compress/uncompress options