cached

Documentation

Index

• type File
  • func (cf File) Close() error
  • func (cf File) Readdir(n int) (fis []os.FileInfo, err error)
  • func (cf File) Serve(w http.ResponseWriter, r *http.Request)
  • func (cf File) Stat() (os.FileInfo, error)
• type FileSystem
  • func NewFileSystem() FileSystem
  • func (cfs FileSystem) GetCacheFallback(key string, populate func() ([]byte, error)) ([]byte, error)
  • func (cfs FileSystem) Open(name string) (base.ServingFile, error)
• type Stat
  • func (s Stat) IsDir() bool
  • func (s Stat) ModTime() time.Time
  • func (s Stat) Mode() os.FileMode
  • func (s Stat) Name() string
  • func (s Stat) Size() int64
  • func (s Stat) Sys() interface{}

Types

type File

type File struct {
	*standard.File
	Key string
	FS  FileSystem
	// contains filtered or unexported fields
}

File Same as fs.File, but cache contents in memory

func (File) Close

func (cf File) Close() error

Close Close actual file if we needed it

func (File) Readdir

func (cf File) Readdir(n int) (fis []os.FileInfo, err error)

Readdir Wrapper around fs.File.Readdir

func (File) Serve

func (cf File) Serve(w http.ResponseWriter, r *http.Request)

Serve Write cached contents to http response

func (File) Stat

func (cf File) Stat() (os.FileInfo, error)

Stat Cached wrapper around os.File.Stat()

type FileSystem

type FileSystem struct {
	base.FileSystem
	Dir    string
	Cache  *bigcache.BigCache
	Logger *log.Entry
}

FileSystem is an http.FileSystem that hides hidden "dot files" from being served.

func NewFileSystem

func NewFileSystem() FileSystem

NewFileSystem Initialise new Cached Filesystem

func (FileSystem) GetCacheFallback

func (cfs FileSystem) GetCacheFallback(key string, populate func() ([]byte, error)) ([]byte, error)

GetCacheFallback Wrapper around bigcache.Get and Set

func (FileSystem) Open

func (cfs FileSystem) Open(name string) (base.ServingFile, error)

Open is a wrapper around the Open method of the embedded FileSystem that serves a 403 permission error when name has a file or directory with whose name starts with a period in its path.

type Stat

type Stat struct {
	NameField    string
	SizeField    int64
	ModTimeField time.Time
	ModeField    os.FileMode
}

func (Stat) IsDir

func (s Stat) IsDir() bool

func (Stat) ModTime

func (s Stat) ModTime() time.Time

func (Stat) Mode

func (s Stat) Mode() os.FileMode

func (Stat) Name

func (s Stat) Name() string

func (Stat) Size

func (s Stat) Size() int64

func (Stat) Sys

func (s Stat) Sys() interface{}