archive

Documentation

Overview

Package archive provides helper tasks related to archives.

Index

• type CreateZipArchive
  • func (c *CreateZipArchive) CompressTo(dest io.Writer) error
• type FileFilterFunc

Types

type CreateZipArchive

type CreateZipArchive struct {
	// SourceDir sets the source dir to compress. Required.
	SourceDir string

	// BasePath sets the base path for the archive files. Defaults to no base path.
	BasePath string

	// FilterFile provides an optional callback to filter a file.
	FilterFile FileFilterFunc
}

CreateZipArchive creates a zip archive from a path.

func (*CreateZipArchive) CompressTo

func (c *CreateZipArchive) CompressTo(dest io.Writer) error

CompressTo compresses to a writer.

type FileFilterFunc

type FileFilterFunc func(path string, info os.FileInfo) bool

FileFilterFunc is the type of the function called for each file visited by archiver. The path argument contains the source dir argument to compress. Returns value indicates the archiver to compress the file or not.