fs

Documentation

Overview

Package fs contains an HTTP file system that works with zip contents.

Index

• Variables
• func ReadFile(hfs http.FileSystem, name string) ([]byte, error)
• func Register(data string)
• func Walk(hfs http.FileSystem, root string, walkFn filepath.WalkFunc) error
• type File
• type StatikFS
  • func New() (*StatikFS, error)
  • func (fs *StatikFS) Open(name string) (http.File, error)

Variables

var ZipData string

Functions

func ReadFile

func ReadFile(hfs http.FileSystem, name string) ([]byte, error)

ReadFile reads the contents of the file of hfs specified by name. Just as ioutil.ReadFile does.

func Register

func Register(data string)

Register registers zip contents data, later used to initialize the statik file system.

func Walk

func Walk(hfs http.FileSystem, root string, walkFn filepath.WalkFunc) error

Walk walks the file tree rooted at root, calling walkFn for each file or directory in the tree, including root. All errors that arise visiting files and directories are filtered by walkFn.

As with filepath.Walk, if the walkFn returns filepath.SkipDir, then the directory is skipped.

Types

type File

type File struct {
	os.FileInfo
	Data []byte
	Fs   *StatikFS
}

file holds unzipped read-only file contents and file metadata.

type StatikFS

type StatikFS struct {
	Files map[string]File
	Dirs  map[string][]string
}

func New

func New() (*StatikFS, error)

New creates a new file system with the registered zip contents data. It unzips all files and stores them in an in-memory map.

func (*StatikFS) Open

func (fs *StatikFS) Open(name string) (http.File, error)

Open returns a file matching the given file name, or os.ErrNotExists if no file matching the given file name is found in the archive. If a directory is requested, Open returns the file named "index.html" in the requested directory, if that file exists.