bindata

Documentation

Overview

Package bindata containers helpers for linking binary assets into programs.

Index

• type Bundle
  • func (b *Bundle) Finish(output io.Writer) error
  • func (b *Bundle) PackageNameOrDefault() string
  • func (b *Bundle) ProcessPath(output io.Writer, pc PathConfig) error
  • func (b *Bundle) Start(output io.Writer) error
• type ByteWriter
  • func NewByteWriter(wr io.Writer) *ByteWriter
  • func (w *ByteWriter) Write(p []byte) (n int, err error)
• type File
• type FileCompressor
  • func NewFileCompressor(src io.ReadCloser) *FileCompressor
  • func (fc *FileCompressor) Close() error
  • func (fc *FileCompressor) WriteTo(dst io.Writer) (written int64, err error)
• type PathConfig

Types

type Bundle

type Bundle struct {
	PackageName string
	Ignores     []*regexp.Regexp
}

Bundle is an assets bundle with associated options.

func (*Bundle) Finish

func (b *Bundle) Finish(output io.Writer) error

Finish closes out the output file

func (*Bundle) PackageNameOrDefault

func (b *Bundle) PackageNameOrDefault() string

PackageNameOrDefault returns the package name or a default.

func (*Bundle) ProcessPath

func (b *Bundle) ProcessPath(output io.Writer, pc PathConfig) error

ProcessPath processes a path with a given config.

func (*Bundle) Start

func (b *Bundle) Start(output io.Writer) error

Start writes the file preamble.

type ByteWriter

type ByteWriter struct {
	io.Writer
	Indent []byte
	// contains filtered or unexported fields
}

ByteWriter writes escaped bytes to a writer.

func NewByteWriter

func NewByteWriter(wr io.Writer) *ByteWriter

NewByteWriter returns a new byte writer.

func (*ByteWriter) Write

func (w *ByteWriter) Write(p []byte) (n int, err error)

type File

type File struct {
	Name     string
	Modtime  time.Time
	Contents *FileCompressor
}

File is both the file metadata and the contents.

type FileCompressor

type FileCompressor struct {
	Source io.ReadCloser
	MD5    hash.Hash
}

FileCompressor reads a file an returns compressed output.

func NewFileCompressor

func NewFileCompressor(src io.ReadCloser) *FileCompressor

NewFileCompressor returns a new file compressor.

func (*FileCompressor) Close

func (fc *FileCompressor) Close() error

Close closes the source stream.

func (*FileCompressor) WriteTo

func (fc *FileCompressor) WriteTo(dst io.Writer) (written int64, err error)

WriteTo copies the source to the destination as a compressed output. It also sums the source into the MD5 hash (uncompressed)>

type PathConfig

type PathConfig struct {
	Path      string
	Recursive bool
}

PathConfig is a path config.