README
¶
AssetFS
AssetFS is a golang package and defined AssetFS Interface that abstracts the access to files.
It has a default implementation that based on FileSystem, which could be used in development, load required files directly from disk.
If you want to compile all required files into a binary and load files from from binary, you could refer our bindatafs
Usage
import "github.com/qor/assetfs"
func main() {
// Default implemention based on filesystem, you could overwrite with other implemention, for example bindatafs will do this.
assetfs := assetfs.AssetFS
// Register path to AssetFS
assetfs.RegisterPath("/web/app/views")
// Prepend path to AssetFS
assetfs.PrependPath("/web/app/views")
// Get file's content with name from path `/web/app/views`
assetfs.Asset("filename.tmpl")
// List matched files from assetfs
assetfs.Glob("*.tmpl")
// NameSpace return namespaced filesystem
namespacedFS := assetfs.NameSpace("asset")
namespacedFS.RegisterPath("/web/app/myspecialviews")
namespacedFS.PrependPath("/web/app/myspecialviews")
// Will lookup file with name "filename.tmpl" from path `/web/app/myspecialviews` but not `/web/app/views`
namespacedFS.Asset("filename.tmpl")
namespacedFS.Glob("*.tmpl")
}
Documentation
¶
Index ¶
- func SetAssetFS(fs Interface)
- type AssetFileSystem
- func (fs *AssetFileSystem) Asset(name string) ([]byte, error)
- func (fs *AssetFileSystem) Compile() error
- func (fs *AssetFileSystem) Glob(pattern string) (matches []string, err error)
- func (fs *AssetFileSystem) NameSpace(nameSpace string) Interface
- func (fs *AssetFileSystem) PrependPath(pth string) error
- func (fs *AssetFileSystem) RegisterPath(pth string) error
- type Interface
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type AssetFileSystem ¶
type AssetFileSystem struct {
// contains filtered or unexported fields
}
AssetFileSystem AssetFS based on FileSystem
func (*AssetFileSystem) Asset ¶
func (fs *AssetFileSystem) Asset(name string) ([]byte, error)
Asset get content with name from assetfs
func (*AssetFileSystem) Compile ¶
func (fs *AssetFileSystem) Compile() error
Compile compile assetfs
func (*AssetFileSystem) Glob ¶
func (fs *AssetFileSystem) Glob(pattern string) (matches []string, err error)
Glob list matched files from assetfs
func (*AssetFileSystem) NameSpace ¶
func (fs *AssetFileSystem) NameSpace(nameSpace string) Interface
NameSpace return namespaced filesystem
func (*AssetFileSystem) PrependPath ¶
func (fs *AssetFileSystem) PrependPath(pth string) error
PrependPath prepend path to view paths
func (*AssetFileSystem) RegisterPath ¶
func (fs *AssetFileSystem) RegisterPath(pth string) error
RegisterPath register view paths
Click to show internal directories.
Click to hide internal directories.