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 Unzip(zf *zip.File) ([]byte, error)
• func Walk(hfs http.FileSystem, root string, walkFn filepath.WalkFunc) error
• type DirInfo
  • func (di DirInfo) IsDir() bool
  • func (di DirInfo) ModTime() time.Time
  • func (di DirInfo) Mode() os.FileMode
  • func (di DirInfo) Name() string
  • func (di DirInfo) RawName() string
  • func (di DirInfo) Size() int64
  • func (di DirInfo) Sys() interface{}
• type File
• type HttpFile
  • func NewHTTPFile(file File) *HttpFile
  • func (f *HttpFile) Close() error
  • func (f *HttpFile) IsDir() bool
  • func (f *HttpFile) Read(p []byte) (n int, err error)
  • func (f *HttpFile) Readdir(count int) ([]os.FileInfo, error)
  • func (f *HttpFile) Seek(offset int64, whence int) (ret int64, err error)
  • func (f *HttpFile) Stat() (os.FileInfo, error)
• type StaticalFS
  • func New() (*StaticalFS, error)
  • func (fs *StaticalFS) 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 statical file system.

func Unzip

func Unzip(zf *zip.File) ([]byte, error)

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 DirInfo

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

func (DirInfo) IsDir

func (di DirInfo) IsDir() bool

func (DirInfo) ModTime

func (di DirInfo) ModTime() time.Time

func (DirInfo) Mode

func (di DirInfo) Mode() os.FileMode

func (DirInfo) Name

func (di DirInfo) Name() string

func (DirInfo) RawName

func (di DirInfo) RawName() string

func (DirInfo) Size

func (di DirInfo) Size() int64

func (DirInfo) Sys

func (di DirInfo) Sys() interface{}

type File

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

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

type HttpFile

type HttpFile struct {
	File
	// contains filtered or unexported fields
}

HttpFile represents an HTTP file and acts as a bridge between file and http.File.

func NewHTTPFile

func NewHTTPFile(file File) *HttpFile

func (*HttpFile) Close

func (f *HttpFile) Close() error

func (*HttpFile) IsDir

func (f *HttpFile) IsDir() bool

func (*HttpFile) Read

func (f *HttpFile) Read(p []byte) (n int, err error)

Read reads bytes into p, returns the number of read bytes.

func (*HttpFile) Readdir

func (f *HttpFile) Readdir(count int) ([]os.FileInfo, error)

Readdir returns an empty slice of files, directory listing is disabled.

func (*HttpFile) Seek

func (f *HttpFile) Seek(offset int64, whence int) (ret int64, err error)

Seek seeks to the offset.

func (*HttpFile) Stat

func (f *HttpFile) Stat() (os.FileInfo, error)

type StaticalFS

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

func New

func New() (*StaticalFS, 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 (*StaticalFS) Open

func (fs *StaticalFS) 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.