bzip2

Documentation

Overview

Package bzip2 implements the BZip2 compressed data format.

Canonical C implementation:

http://bzip.org

Unofficial format specification:

https://github.com/dsnet/compress/blob/master/doc/bzip2-format.pdf

Index

• Constants
• type Reader
  • func NewReader(r io.Reader, conf *ReaderConfig) (*Reader, error)
  • func (zr *Reader) Close() error
  • func (zr *Reader) Read(buf []byte) (int, error)
  • func (zr *Reader) Reset(r io.Reader) error
• type ReaderConfig
• type Writer
  • func NewWriter(w io.Writer, conf *WriterConfig) (*Writer, error)
  • func (zw *Writer) Close() error
  • func (zw *Writer) Reset(w io.Writer) error
  • func (zw *Writer) Write(buf []byte) (int, error)
• type WriterConfig

Constants

const (
	BestSpeed          = 1
	BestCompression    = 9
	DefaultCompression = 6
)

Types

type Reader

type Reader struct {
	InputOffset  int64 // Total number of bytes read from underlying io.Reader
	OutputOffset int64 // Total number of bytes emitted from Read
	// contains filtered or unexported fields
}

func NewReader

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

func (*Reader) Close

func (zr *Reader) Close() error

func (*Reader) Read

func (zr *Reader) Read(buf []byte) (int, error)

func (*Reader) Reset

func (zr *Reader) Reset(r io.Reader) error

type ReaderConfig

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

type Writer

type Writer struct {
	InputOffset  int64 // Total number of bytes issued to Write
	OutputOffset int64 // Total number of bytes written to underlying io.Writer
	// contains filtered or unexported fields
}

func NewWriter

func NewWriter(w io.Writer, conf *WriterConfig) (*Writer, error)

func (*Writer) Close

func (zw *Writer) Close() error

func (*Writer) Reset

func (zw *Writer) Reset(w io.Writer) error

func (*Writer) Write

func (zw *Writer) Write(buf []byte) (int, error)

type WriterConfig

type WriterConfig struct {
	Level int
	// contains filtered or unexported fields
}