afs

Documentation

Index

• Constants
• type AFS
  • func New() *AFS
  • func (afs *AFS) CloseAll()
  • func (afs *AFS) LoadAssets(dir string) error
  • func (afs *AFS) Open(path string) (types.AFSFile, error)
  • func (afs *AFS) ReadFile(path string) ([]byte, error)
  • func (afs *AFS) Use(key string) types.AFSFile
  • func (afs *AFS) WithCachedFs() *AFS
  • func (afs *AFS) WithMemFs() *AFS
  • func (afs *AFS) WithStatic(static string) (*AFS, error)
  • func (afs *AFS) Write(path string, data []byte, perm os.FileMode) error

Constants

const (
	// ReadAllWriteUser gives specified permissions
	ReadAllWriteUser os.FileMode = 0644
	// ReadExecAllWriteUser gives specified permissions
	ReadExecAllWriteUser os.FileMode = 0755
)

Types

type AFS

type AFS struct {
	// contains filtered or unexported fields
}

AFS abstracts over the filesystem providing read/write access to an in memory filesystem, or a cached os file system

func New

func New() *AFS

New returns a new FS

func (*AFS) CloseAll

func (afs *AFS) CloseAll()

CloseAll closes all cached files

func (*AFS) LoadAssets

func (afs *AFS) LoadAssets(dir string) error

LoadAssets walks the given directory, opening and caching assets

func (*AFS) Open

func (afs *AFS) Open(path string) (types.AFSFile, error)

Open a reader for the file at the specified path on the file system

func (*AFS) ReadFile

func (afs *AFS) ReadFile(path string) ([]byte, error)

ReadFile opens file on the filesytem into a []byte array

func (*AFS) Use

func (afs *AFS) Use(key string) types.AFSFile

Use returns the reader of a file under the specified key

func (*AFS) WithCachedFs

func (afs *AFS) WithCachedFs() *AFS

WithCachedFs creates a cached os file system

func (*AFS) WithMemFs

func (afs *AFS) WithMemFs() *AFS

WithMemFs creates an underlying in memory filesystem

func (*AFS) WithStatic

func (afs *AFS) WithStatic(static string) (*AFS, error)

WithStatic loads the given static assets into the server

func (*AFS) Write

func (afs *AFS) Write(path string, data []byte, perm os.FileMode) error

Write saves file to file system