flexzlib

Documentation

Index

• Variables
• type Inflator
  • func NewInflator() *Inflator
  • func (i *Inflator) Inflate(p []byte) ([]byte, error)
  • func (i *Inflator) Read(p []byte) (int, error)
• type Reader
  • func NewReader(r io.Reader) (*Reader, error)
  • func NewReaderDict(r io.Reader, dict []byte) (*Reader, error)
  • func (z *Reader) Close() error
  • func (z *Reader) Read(p []byte) (n int, err error)
  • func (z *Reader) Reset(r io.Reader, dict []byte) error
  • func (z *Reader) SwapReader(r io.Reader)
• type Resetter

Variables

var (
	// ErrChecksum is returned when reading ZLIB data that has an invalid checksum.
	ErrChecksum = errors.New("zlib: invalid checksum")
	// ErrDictionary is returned when reading ZLIB data that has an invalid dictionary.
	ErrDictionary = errors.New("zlib: invalid dictionary")
	// ErrHeader is returned when reading ZLIB data that has an invalid header.
	ErrHeader = errors.New("zlib: invalid header")
)

Types

type Inflator

type Inflator struct {
	// contains filtered or unexported fields
}

func NewInflator

func NewInflator() *Inflator

func (*Inflator) Inflate

func (i *Inflator) Inflate(p []byte) ([]byte, error)

func (*Inflator) Read

func (i *Inflator) Read(p []byte) (int, error)

type Reader

type Reader struct {
	// contains filtered or unexported fields
}

func NewReader

func NewReader(r io.Reader) (*Reader, error)

NewReader creates a new ReadCloser. Reads from the returned ReadCloser read and decompress data from r. The implementation buffers input and may read more data than necessary from r. It is the caller's responsibility to call Close on the ReadCloser when done.

The ReadCloser returned by NewReader also implements Resetter.

func NewReaderDict

func NewReaderDict(r io.Reader, dict []byte) (*Reader, error)

NewReaderDict is like NewReader but uses a preset dictionary. NewReaderDict ignores the dictionary if the compressed data does not refer to it. If the compressed data refers to a different dictionary, NewReaderDict returns ErrDictionary.

The ReadCloser returned by NewReaderDict also implements Resetter.

func (*Reader) Close

func (z *Reader) Close() error

Calling Close does not close the wrapped io.Reader originally passed to NewReader.

func (*Reader) Read

func (z *Reader) Read(p []byte) (n int, err error)

func (*Reader) Reset

func (z *Reader) Reset(r io.Reader, dict []byte) error

func (*Reader) SwapReader

func (z *Reader) SwapReader(r io.Reader)

type Resetter

type Resetter interface {
	// Reset discards any buffered data and resets the Resetter as if it was
	// newly initialized with the given reader.
	Reset(r io.Reader, dict []byte) error
}

Resetter resets a ReadCloser returned by NewReader or NewReaderDict to to switch to a new underlying Reader. This permits reusing a ReadCloser instead of allocating a new one.