bzip2

README

bzip2

Package bzip2 implements reading and writing of bzip2 format compressed files.

Currently this focuses on the writer since compress/bzip2 doesn't include one.

Hopefully this will be eventually merged into the standard library without any changes on the users part.

Notes

References used to write the writer since there's no specification:

• https://en.wikipedia.org/wiki/Bzip2
• https://bzip.org
• https://code.google.com/p/jbzip2
• http://lbzip2.org/

Install

go get github.com/larzconwell/bzip2

License

MIT licensed, see here

Documentation

Overview

Package bzip2 implements reading and writing of bzip2 format compressed files.

Index

• Constants
• type Writer
  • func NewWriter(w io.Writer) *Writer
  • func NewWriterLevel(w io.Writer, level int) (*Writer, error)
  • func (w *Writer) Close() error
  • func (w *Writer) Flush() error
  • func (w *Writer) Reset(dst io.Writer)
  • func (w *Writer) Write(p []byte) (int, error)

Constants

const (
	BestSpeed       = flate.BestSpeed
	BestCompression = flate.BestCompression
)

These constants are copied from the flate package, so that code does not also have to import "compress/flate".

Types

type Writer

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

Writer is an io.WriteCloser. Writes to a Writer are compressed and written to an underlying io.Writer.

func NewWriter

func NewWriter(w io.Writer) *Writer

NewWriter returns a new Writer. Writes to the returned writer are compressed and written to w.

It is the caller's responsibility to call Close on the Writer when done. Writes may be buffered and not flushed until Close.

func NewWriterLevel

func NewWriterLevel(w io.Writer, level int) (*Writer, error)

NewWriterLevel is like NewWriter but specifies the compression level.

The levels range from 1 (BestSpeed) to 9 (BestCompression); higher levels typically run slower but compress more.

If level is in the range [1, 9] then the error returned will be nil. Otherwise the error returned will be non-nil.

func (*Writer) Close

func (w *Writer) Close() error

Close closes the Writer, flushing any unwritten data to the underlying io.Writer, but does not close the underlying io.Writer.

func (*Writer) Flush

func (w *Writer) Flush() error

Flush flushes any pending compressed data to the underlying writer.

func (*Writer) Reset

func (w *Writer) Reset(dst io.Writer)

Reset discards the state of Writer and makes it equivalent to the result of NewWriter or NewWriterLevel, but writing to dst instead.

func (*Writer) Write

func (w *Writer) Write(p []byte) (int, error)

Write writes a compressed form of p to the underlying io.Writer. The compressed bytes are not necessarily flushed until the Writer is closed.