virtual

Documentation

Index

• func Exclude(fsys fs.FS, fn func(path string) bool) fs.FS
• func MarshalJSON(file fs.File) ([]byte, error)
• func Open(f *File) fs.File
• func Print(fsys fs.FS) (string, error)
• func UnmarshalJSON(file []byte) (fs.File, error)
• type DirEntry
  • func (e *DirEntry) Info() (fs.FileInfo, error)
  • func (e *DirEntry) IsDir() bool
  • func (e *DirEntry) Name() string
  • func (e *DirEntry) Type() fs.FileMode
• type FS
• type File
  • func From(file fs.File) (entry *File, err error)
  • func (f *File) Embed() string
  • func (f *File) Info() (fs.FileInfo, error)
  • func (f *File) IsDir() bool
  • func (f *File) Name() string
  • func (f *File) Stamp() (stamp string, err error)
  • func (f *File) Type() fs.FileMode
• type Map
  • func (fsys Map) MkdirAll(path string, perm fs.FileMode) error
  • func (fsys Map) Open(path string) (fs.File, error)
  • func (fsys Map) RemoveAll(path string) error
  • func (fsys Map) Sub(dir string) (FS, error)
  • func (fsys Map) WriteFile(path string, data []byte, perm fs.FileMode) error
• type OS
  • func (dir OS) MkdirAll(path string, perm fs.FileMode) error
  • func (dir OS) Open(name string) (fs.File, error)
  • func (dir OS) RemoveAll(path string) error
  • func (dir OS) Sub(subdir string) (FS, error)
  • func (dir OS) WriteFile(name string, data []byte, perm fs.FileMode) error
• type Tree
  • func (t Tree) MkdirAll(path string, perm fs.FileMode) error
  • func (fsys Tree) Open(path string) (fs.File, error)
  • func (t Tree) RemoveAll(path string) error
  • func (t Tree) Sub(dir string) (FS, error)
  • func (t Tree) WriteFile(path string, data []byte, perm fs.FileMode) error

Functions

func Exclude

func Exclude(fsys fs.FS, fn func(path string) bool) fs.FS

func MarshalJSON

func MarshalJSON(file fs.File) ([]byte, error)

func Open

func Open(f *File) fs.File

func Print

func Print(fsys fs.FS) (string, error)

Print out a virtual filesystem.

func UnmarshalJSON

func UnmarshalJSON(file []byte) (fs.File, error)

Types

type DirEntry

type DirEntry struct {
	Path    string
	Size    int64
	Mode    fs.FileMode
	ModTime time.Time
}

func (*DirEntry) Info

func (e *DirEntry) Info() (fs.FileInfo, error)

func (*DirEntry) IsDir

func (e *DirEntry) IsDir() bool

func (*DirEntry) Name

func (e *DirEntry) Name() string

func (*DirEntry) Type

func (e *DirEntry) Type() fs.FileMode

type FS

type FS interface {
	fs.FS
	MkdirAll(path string, perm fs.FileMode) error
	WriteFile(name string, data []byte, perm fs.FileMode) error
	RemoveAll(path string) error
	Sub(path string) (FS, error)
}

type File

type File struct {
	Path    string
	Data    []byte
	Mode    fs.FileMode
	ModTime time.Time
	Entries []fs.DirEntry
}

func From

func From(file fs.File) (entry *File, err error)

From a file to a virtual file

func (*File) Embed

func (f *File) Embed() string

Embed as a string literal. https://github.com/go-bindata/go-bindata/blob/26949cc13d95310ffcc491c325da869a5aafce8f/stringwriter.go#L18-L36

func (*File) Info

func (f *File) Info() (fs.FileInfo, error)

Returns the file info. Implements the fs.DirEntry interface.

func (*File) IsDir

func (f *File) IsDir() bool

Returns true if entry is a directory. Implements the fs.DirEntry interface.

func (*File) Name

func (f *File) Name() string

Name of the entry. Implements the fs.DirEntry interface.

func (*File) Stamp

func (f *File) Stamp() (stamp string, err error)

Stamp helps quickly determine if a file has changed.

func (*File) Type

func (f *File) Type() fs.FileMode

Returns the type of entry. Implements the fs.DirEntry interface.

type Map

type Map map[string]*File

func (Map) MkdirAll

func (fsys Map) MkdirAll(path string, perm fs.FileMode) error

Mkdir create a directory.

func (Map) Open

func (fsys Map) Open(path string) (fs.File, error)

func (Map) RemoveAll

func (fsys Map) RemoveAll(path string) error

Remove removes a path

func (Map) Sub

func (fsys Map) Sub(dir string) (FS, error)

Sub returns a submap

func (Map) WriteFile

func (fsys Map) WriteFile(path string, data []byte, perm fs.FileMode) error

WriteFile writes a file

type OS

type OS string

OS creates a new OS filesystem rooted at the given directory. TODO: create an os_windows for opening on multiple drives with the same API: https://github.com/golang/go/issues/44279#issuecomment-955766528

func (OS) MkdirAll

func (dir OS) MkdirAll(path string, perm fs.FileMode) error

func (OS) Open

func (dir OS) Open(name string) (fs.File, error)

func (OS) RemoveAll

func (dir OS) RemoveAll(path string) error

func (OS) Sub

func (dir OS) Sub(subdir string) (FS, error)

func (OS) WriteFile

func (dir OS) WriteFile(name string, data []byte, perm fs.FileMode) error

type Tree

type Tree map[string]*File

func (Tree) MkdirAll

func (t Tree) MkdirAll(path string, perm fs.FileMode) error

Mkdir create a directory.

func (Tree) Open

func (fsys Tree) Open(path string) (fs.File, error)

func (Tree) RemoveAll

func (t Tree) RemoveAll(path string) error

Remove removes a path

func (Tree) Sub

func (t Tree) Sub(dir string) (FS, error)

Sub returns a subtree

func (Tree) WriteFile

func (t Tree) WriteFile(path string, data []byte, perm fs.FileMode) error

WriteFile writes a file TODO: WriteFile should fail if path.Dir(name) doesn't exist