zipscanner

README

zipscanner

A zip file library that scan the file sequentially and tries to extract its content

This library implements a bufio.Scanner like interface that operates on a zip file. It tries to parse the zip file sequentially in order to avoid seeks to the central directory (useful for streaming zip content from a network resource)

Documentation

Index

• Variables
• type ZipScanner
• type ZipScannerImpl
  • func NewZipScanner(r io.Reader) *ZipScannerImpl
  • func (r *ZipScannerImpl) Error() error
  • func (r *ZipScannerImpl) FileHeader() zip.FileHeader
  • func (r *ZipScannerImpl) Reader() (io.Reader, error)
  • func (r *ZipScannerImpl) Scan() bool
• type ZipWrapper
  • func NewZipWrapper(z *zip.Reader) *ZipWrapper
  • func (z *ZipWrapper) Error() error
  • func (z *ZipWrapper) FileHeader() zip.FileHeader
  • func (z *ZipWrapper) Reader() (io.Reader, error)
  • func (z *ZipWrapper) Scan() bool

Variables

var (
	InvalidFileHeader           = errors.New("invalid file header")
	InvalidDataDescriptorHeader = errors.New("invalid data descriptor header")
	UnsupportedCompression      = errors.New("unsupported compression mode")
	NoUncompressedSize          = errors.New("missing uncompressed size")
)

Types

type ZipScanner

type ZipScanner interface {
	Scan() bool
	FileHeader() zip.FileHeader
	Reader() (io.Reader, error)
	Error() error
}

type ZipScannerImpl

type ZipScannerImpl struct {
	Debug bool
	// contains filtered or unexported fields
}

func NewZipScanner

func NewZipScanner(r io.Reader) *ZipScannerImpl

func (*ZipScannerImpl) Error

func (r *ZipScannerImpl) Error() error

func (*ZipScannerImpl) FileHeader

func (r *ZipScannerImpl) FileHeader() zip.FileHeader

func (*ZipScannerImpl) Reader

func (r *ZipScannerImpl) Reader() (io.Reader, error)

func (*ZipScannerImpl) Scan

func (r *ZipScannerImpl) Scan() bool

type ZipWrapper

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

ZipWrapper wraps a zip.Reader into a ZipScanner compatible interface

func NewZipWrapper

func NewZipWrapper(z *zip.Reader) *ZipWrapper

func (*ZipWrapper) Error

func (z *ZipWrapper) Error() error

func (*ZipWrapper) FileHeader

func (z *ZipWrapper) FileHeader() zip.FileHeader

func (*ZipWrapper) Reader

func (z *ZipWrapper) Reader() (io.Reader, error)

func (*ZipWrapper) Scan

func (z *ZipWrapper) Scan() bool