gzip

Documentation

Overview

Package gzip implements reading and writing of gzip format compressed files. See the compress/gzip package for more details.

Index

• type Reader
  • func NewReader(r io.Reader, name string) (*Reader, error)
  • func (r *Reader) NextFile() (name string, err error)
• type Writer
  • func NewWriter(w io.Writer) *Writer
  • func (w *Writer) NextFile(name string, _ os.FileInfo) error

Types

type Reader

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

Reader is an io.Reader that can be read to retrieve uncompressed data from a gzip-format compressed file.

func NewReader

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

NewReader creates a new Reader reading the given reader.

func (*Reader) NextFile

func (r *Reader) NextFile() (name string, err error)

NextFile returns the file name. Calls subsequent to the first call will return EOF.

type Writer

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

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

func NewWriter

func NewWriter(w io.Writer) *Writer

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

func (*Writer) NextFile

func (w *Writer) NextFile(name string, _ os.FileInfo) error

NextFile never returns a next file, and should not be called more than once.