assets

Documentation

Overview

Package assets provides functionality to load asset files that were packed into the binary during compilation.

Index

• type Bundler
• type Environment
  • func (env *Environment) Include(options ...func(*Environment)) script.Option
  • func (env *Environment) Library(options ...func(*Environment)) script.Library
  • func (env *Environment) Require(filePath string) (err error)
• type NamedReader
• type TarGZBundler
  • func NewTarGZBundler(files ...NamedReader) (*TarGZBundler, error)
  • func (tb *TarGZBundler) Bundle(files ...NamedReader) error
  • func (tb *TarGZBundler) FileSystem() (afero.Fs, error)

Types

type Bundler

type Bundler interface {
	Bundle(...NamedReader) error
}

Bundler is an interface for handling multi-file (de)serialization and creation of a http.FileSystem

type Environment

type Environment struct {
	Assets     afero.Fs
	Files      []NamedReader
	Downloader cdn.Downloader
}

Environment used to configure the behaviour of calls to the ssh library.

func (*Environment) Include

func (env *Environment) Include(options ...func(*Environment)) script.Option

Include the assets library in a script environment.

func (*Environment) Library

func (env *Environment) Library(options ...func(*Environment)) script.Library

Library prepares a new assets library for use within a script environment.

func (*Environment) Require

func (env *Environment) Require(filePath string) (err error)

Require will be used in the init function for the worker to specify which files you wish to include in the asset bundle which will be accessible on the target. Will fatal if error occurs.

@callable: assets.require @param: filePath @String

@usage: assets.require("file_on_cdn")

type NamedReader

type NamedReader struct {
	io.Reader
	Name string
}

NamedReader is a basic struct to organize the data needed for the Bundler

type TarGZBundler

type TarGZBundler struct {
	Buffer *bytes.Buffer
}

TarGZBundler is the concrete implementation of Bundle using Tar and GZip

func NewTarGZBundler

func NewTarGZBundler(files ...NamedReader) (*TarGZBundler, error)

NewTarGZBundler initializes a new tar bundler of the provided files.

func (*TarGZBundler) Bundle

func (tb *TarGZBundler) Bundle(files ...NamedReader) error

Bundle is used to add multiple files into a tar bundle

func (*TarGZBundler) FileSystem

func (tb *TarGZBundler) FileSystem() (afero.Fs, error)

FileSystem is used to convert a targz bundle into an in memory http.FileSystem