binfs

Documentation

Index

• type Config
  • func (c Config) MustPreload() FileSystem
  • func (c Config) New() FileSystem
  • func (c Config) Preload() (FileSystem, error)
• type FileSystem
  • func Override(path string, fs FileSystem) (FileSystem, error)

Types

type Config

type Config struct {
	Mode bingen.Mode
	Gzip bool
	Data interface{}
}

func (Config) MustPreload

func (c Config) MustPreload() FileSystem

func (Config) New

func (c Config) New() FileSystem

func (Config) Preload

func (c Config) Preload() (FileSystem, error)

type FileSystem

type FileSystem interface {
	http.FileSystem
	Preload() (FileSystem, error)
	ReadFile(path string) ([]byte, error)
}

func Override

func Override(path string, fs FileSystem) (FileSystem, error)

Override a FileSystem with a physical path - use this in development to mask the baked-in FileSystem with updatable versions stored locally.