README
¶
We use https://github.com/jteeuwen/go-bindata to convert the resources directory and its contents
into compile-able go code, so the files can compiled into an executable as addressable resources
or assets.
Build instructions
------------------
These are scripted in make.bat
To access resources programatically
-------------------------------------
data, err := Asset("pub/style/foo.css")
Or wrap a virtual file system around it using:
https://github.com/elazarl/go-bindata-assetfs
Documentation
¶
Index ¶
- Variables
- func Asset(name string) ([]byte, error)
- func AssetDir(name string) ([]string, error)
- func AssetInfo(name string) (os.FileInfo, error)
- func AssetNames() []string
- func GetExampleFileContents(exampleType ExampleInputFileType) string
- func MustAsset(name string) []byte
- func RestoreAsset(dir, name string) error
- func RestoreAssets(dir, name string) error
- type ExampleInputFileType
Constants ¶
This section is empty.
Variables ¶
var CompiledFileSystem http.FileSystem = &assetfs.AssetFS{ Asset: Asset, AssetDir: AssetDir, AssetInfo: AssetInfo}
The CompiledFileSystem package-global variable is an object which looks to the outside world like an http.FileSystem, but which under the hood is backed by resources captured at compile time. It is exported for the benefit of initialising the web server at boot time, but is not intended to be accessed from outside the package for any other reason.
var CompiledTemplates = compileTemplates()
The CompiledTemplates package-global variable provides access to the html template for rendering the gui, having extracted the template files from the behind-the-scenes, compiled-in assets.
Functions ¶
func Asset ¶
Asset loads and returns the asset for the given name. It returns an error if the asset could not be found or could not be loaded.
func AssetDir ¶
AssetDir returns the file names below a certain directory embedded in the file by go-bindata. For example if you run go-bindata on data/... and data contains the following hierarchy:
data/
foo.txt
img/
a.png
b.png
then AssetDir("data") would return []string{"foo.txt", "img"} AssetDir("data/img") would return []string{"a.png", "b.png"} AssetDir("foo.txt") and AssetDir("notexist") would return an error AssetDir("") will return []string{"data"}.
func AssetInfo ¶
AssetInfo loads and returns the asset info for the given name. It returns an error if the asset could not be found or could not be loaded.
func GetExampleFileContents ¶
func GetExampleFileContents(exampleType ExampleInputFileType) string
The GetExampleFileContents function provides convenient access to the canned example input files that have been compiled in to the program as assets, in terms of their meta role rather than use their file names directly. E.g. "get me the space delimitted input file example".
func MustAsset ¶
MustAsset is like Asset but panics when Asset would return an error. It simplifies safe initialization of global variables.
func RestoreAsset ¶
RestoreAsset restores an asset under the given directory
func RestoreAssets ¶
RestoreAssets restores an asset under the given directory recursively
Types ¶
type ExampleInputFileType ¶
type ExampleInputFileType int // See the enumeration below.
const (
SpaceDelimitedExample ExampleInputFileType = iota
)
Source Files