gzip0

Documentation

Overview

Package gzip0 implements writing of uncompressed (compression level 0) gzip files. The data in the files is uncompressed but still framed and checksummed, protecting against undetected corruption or truncation.

Index

• type Writer
  • func NewWriter(w io.Writer) *Writer
  • func (w *Writer) Close() error
  • func (w *Writer) Write(b []byte) (int, error)

Types

type Writer

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

A Writer is an io.WriteCloser. Writes to a Writer are written to w in uncompressed gzip format.

func NewWriter

func NewWriter(w io.Writer) *Writer

NewWriter returns a new Writer. Writes to the returned Writer are written to w in uncompressed gzip format.

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

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) Write

func (w *Writer) Write(b []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.