assets

Documentation

Overview

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

Index

• Variables
• type Environment
  • func (env *Environment) Include(options ...func(*Environment)) script.Option
  • func (env *Environment) Library(options ...func(*Environment)) script.Library
  • func (env *Environment) OpenFile(path string) (file.Type, error)
• type File
  • func (f File) Chmod(os.FileMode) error
  • func (f File) Chown(uid, gid int) error
  • func (f File) Move(dstPath string) error
  • func (f File) Name() string
  • func (f File) Remove() error
  • func (f File) Sync() error
  • func (f File) Write(p []byte) (int, error)

Variables

var ErrUnsupported = fmt.Errorf("operation not supported for asset file")

Types

type Environment

type Environment struct {
	Assets http.FileSystem
}

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) OpenFile

func (env *Environment) OpenFile(path string) (file.Type, error)

OpenFile that was packed into the compiled binary. The resulting file does not support many operations such as Chown, Write, etc. but you may read it's contents or copy it to another file i.e. one opened by ssh or sys.

@callable: assets.openFile @param: path @String @retval: file @File @retval: err @Error

@usage: f, err = assets.openFile("/path/to/asset")

type File

type File struct {
	http.File
	// contains filtered or unexported fields
}

func (File) Chmod

func (f File) Chmod(os.FileMode) error

Chmod is unsupported and always returns an error.

func (File) Chown

func (f File) Chown(uid, gid int) error

Chown is unsupported and always returns an error.

func (File) Move

func (f File) Move(dstPath string) error

Move is unsupported and always returns an error.

func (File) Name

func (f File) Name() string

Name of the file as provided to openFile.

func (File) Remove

func (f File) Remove() error

Remove is unsupported and always returns an error.

func (File) Sync

func (f File) Sync() error

Sync does nothing.

func (File) Write

func (f File) Write(p []byte) (int, error)

Write is unsupported and always returns an error.