packer

Documentation

Overview

Package packer implements the core packing functionality. It is designed to be used by a wrapper program (CLI etc.).

Index

• func Pack(filesToPack FilesToPack, outputFilename string) error
• func Pack2(filesToPack FilesToPack, outputFilename string, progress Progress) error
• type FileToPack
• type FilesToPack
• type Progress

Functions

func Pack

func Pack(filesToPack FilesToPack, outputFilename string) error

Pack a file. Use Pack2 for progress reporting.

func Pack2

func Pack2(filesToPack FilesToPack, outputFilename string, progress Progress) error

Pack2 will pack a file, with progress reporting. The progress interface may be nil.

Types

type FileToPack

type FileToPack struct {
	// Filename is the path to the file on disk (relative or absolute).
	Filename string `yaml:"filename"`

	// ContentType is used as the Content-Type header for the source data.
	ContentType string `yaml:"content_type"`

	// DisableCompression can be set to skip any compression for this file.
	DisableCompression bool `yaml:"disable_compression"`

	// DisableGzip can be set to skip gzip compression for this file.
	DisableGzip bool `yaml:"disable_gzip"`

	// DisableBrotli can be set to skip brotli compression for this file.
	DisableBrotli bool `yaml:"disable_brotli"`
}

FileToPack contains the headers / options for a file which is about to be packed.

type FilesToPack

type FilesToPack map[string]FileToPack

FilesToPack is the set of files which will be incorporated into the packfile. The key is the path at which the file will be served, and the value gives the disk filename as well as headers / options.

type Progress

type Progress interface {
	// Count reports the number of items that have begun processing.
	Count(n int)

	// Begin denotes the processing of an input file.
	Begin(filename, compression string)

	// End denotes the completion of input file processing.
	End(filename, compression string)
}

Progress is a callback object which reports packing progress.