zstpak

Documentation

Index

• func CompressInto(in io.Reader, out io.Writer, chunkSize uint64) error
• type Reader
  • func Open(path string) (*Reader, error)
  • func (reader *Reader) ChunkSize() uint64
  • func (reader *Reader) Close() error
  • func (reader *Reader) ReadAt(p []byte, off int64) (n int, err error)
  • func (reader *Reader) UncompressedSize() uint64

Functions

func CompressInto

func CompressInto(in io.Reader, out io.Writer, chunkSize uint64) error

CompressInto reads data from an input reader, writing it out in compressed form. The chunk size determines how often to create new chunks. Higher numbers increase compression rates, but come at the cost of making random access less efficient.

Types

type Reader

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

Reader allows random access reads within zstpak files. Created via the `Open` method.

func Open

func Open(path string) (*Reader, error)

Open a zstpak file for random access reading.

func (*Reader) ChunkSize

func (reader *Reader) ChunkSize() uint64

ChunkSize returns the size of the compressed chunks in this file.

func (*Reader) Close

func (reader *Reader) Close() error

Close implements the `Closer` interface.

func (*Reader) ReadAt

func (reader *Reader) ReadAt(p []byte, off int64) (n int, err error)

ReadAt implements the `ReaderAt` interface.

func (*Reader) UncompressedSize

func (reader *Reader) UncompressedSize() uint64

UncompressedSize returns the size of the packed file if it was fully decompressed.