zreader

README

ZReader

ZReader is a Go module that provides an io.ReadCloser for a variety of compression formats.

Documentation

Overview

Package zreader provides an io.ReadCloser for a variety of compression formats.

Index

• type ZReader
  • func NewReader(r io.Reader) (*ZReader, error)
  • func Open(pathname string) (*ZReader, error)
  • func (r *ZReader) Close() error
  • func (r *ZReader) Read(p []byte) (int, error)

Types

type ZReader

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

ZReader is an io.ReadCloser that reads compressed files.

It currently supports bzip2, gzip, and zstd.

func NewReader

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

NewReader returns a ZReader for the given io.ReadCloser. It selects a decompressor based on the first few bytes of data. If it does not have a decompressor to match the bytes, subsequent calls to [Read] will return the raw bytes of the reader. (That might, or might not, be what you want.)

func Open

func Open(pathname string) (*ZReader, error)

Open opens pathname and returns an appropriate ZReader. See NewReader for guidance on its behavior.

func (*ZReader) Close

func (r *ZReader) Close() error

Close closes the ZReader, and will close the underlying reader if it has one.

func (*ZReader) Read

func (r *ZReader) Read(p []byte) (int, error)

Read reads from the appropriate decompressor.