vfs

Documentation

Index

• type File
• type Root
• type SeekableFile
• type VFS
  • func Instrumented(fs VFS) VFS

Types

type File

type File interface {
	io.Reader
	io.Closer
}

File represents an open file, which will typically be the response body of a Pages request.

type Root

type Root interface {
	Lstat(ctx context.Context, name string) (os.FileInfo, error)
	Readlink(ctx context.Context, name string) (string, error)
	Open(ctx context.Context, name string) (File, error)
}

Root abstracts the things Pages needs to serve a static site from a given root rootPath.

type SeekableFile

type SeekableFile interface {
	File
	io.Seeker
}

SeekableFile represents a seekable file, which will typically be the response body of a Pages request.

type VFS

type VFS interface {
	Root(ctx context.Context, path string, cacheKey string) (Root, error)
	Name() string
	Reconfigure(config *config.Config) error
}

VFS abstracts the things Pages needs to serve a static site from disk.

func Instrumented

func Instrumented(fs VFS) VFS