Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

vfs

package

Go to main page

Versions in this module

v0

v0.8.0

Jan 27, 2026

Changes in this version

+ var ErrSkipDir = errors.New("skip this directory")

v0.7.0

Nov 7, 2025

v0.6.0

Dec 1, 2024

Changes in this version

+ var ErrInvalidPath = errors.New("invalid path: attempt to access parent directory")

v0.5.3

Nov 30, 2022

v0.5.2

Nov 20, 2022

v0.5.1

Nov 19, 2022

v0.5.0

Nov 19, 2022

v0.4.0

Nov 19, 2022

v0.3.3

Oct 10, 2022

Changes in this version

+ const ModeCompress

+ var ErrReadOnly = errors.New("can't write to read only file")

+ var ErrReadOnlyFileSystem = errors.New("read-only filesystem")

+ var ErrWriteOnly = errors.New("can't read from write only file")

+ var SkipDir = errors.New("skip this directory")

+ func Clone(dst VFS, src VFS) error

+ func Compress(fs VFS) error

+ func IsExist(err error) bool

+ func IsNotExist(err error) bool

+ func MkdirAll(fs VFS, path string, perm os.FileMode) error

+ func ReadFile(fs VFS, path string) ([]byte, error)

+ func RemoveAll(fs VFS, path string) error

+ func Walk(fs VFS, root string, fn WalkFunc) error

+ func WriteFile(fs VFS, path string, data []byte, perm os.FileMode) error

+ func WriteTar(w io.Writer, fs VFS) error

+ func WriteTarGzip(w io.Writer, fs VFS) error

+ func WriteZip(w io.Writer, fs VFS) error

+ type Compressor interface

+ IsCompressed func() bool

+ SetCompressed func(c bool)

+ type Container interface

+ VFS func() VFS

+ type Dir struct

+ Entries []Entry

+ EntryNames []string

+ ModTime time.Time

+ Mode os.FileMode

+ func (d *Dir) Add(name string, entry Entry) error

+ func (d *Dir) FileMode() os.FileMode

+ func (d *Dir) Find(name string) (Entry, int, error)

+ func (d *Dir) ModificationTime() time.Time

+ func (d *Dir) Size() int64

+ func (d *Dir) Type() EntryType

+ type Entry interface

+ FileMode func() os.FileMode

+ ModificationTime func() time.Time

+ Size func() int64

+ Type func() EntryType

+ type EntryInfo struct

+ Entry Entry

+ Path string

+ func (info *EntryInfo) IsDir() bool

+ func (info *EntryInfo) ModTime() time.Time

+ func (info *EntryInfo) Mode() os.FileMode

+ func (info *EntryInfo) Name() string

+ func (info *EntryInfo) Size() int64

+ func (info *EntryInfo) Sys() interface{}

+ type EntryType uint8

+ const EntryTypeDir

+ const EntryTypeFile

+ type File struct

+ Data []byte

+ ModTime time.Time

+ Mode os.FileMode

+ func (f *File) FileMode() os.FileMode

+ func (f *File) ModificationTime() time.Time

+ func (f *File) Size() int64

+ func (f *File) Type() EntryType

+ type FileInfos []os.FileInfo

+ func (f FileInfos) Len() int

+ func (f FileInfos) Less(i, j int) bool

+ func (f FileInfos) Swap(i, j int)

+ type Mounter struct

+ func (m *Mounter) Lstat(path string) (os.FileInfo, error)

+ func (m *Mounter) Mkdir(path string, perm os.FileMode) error

+ func (m *Mounter) Mount(fs VFS, point string) error

+ func (m *Mounter) Open(path string) (RFile, error)

+ func (m *Mounter) OpenFile(path string, flag int, perm os.FileMode) (WFile, error)

+ func (m *Mounter) ReadDir(path string) ([]os.FileInfo, error)

+ func (m *Mounter) Remove(path string) error

+ func (m *Mounter) Stat(path string) (os.FileInfo, error)

+ func (m *Mounter) String() string

+ func (m *Mounter) Umount(point string) error

+ type Opener interface

+ Open func(path string) (RFile, error)

+ OpenFile func(path string, flag int, perm os.FileMode) (WFile, error)

+ type RFile interface

+ func NewRFile(f *File) (RFile, error)

+ type TemporaryVFS interface

+ Close func() error

+ Root func() string

+ func TmpFS(prefix string) (TemporaryVFS, error)

+ type VFS interface

+ Lstat func(path string) (os.FileInfo, error)

+ Mkdir func(path string, perm os.FileMode) error

+ ReadDir func(path string) ([]os.FileInfo, error)

+ Remove func(path string) error

+ Stat func(path string) (os.FileInfo, error)

+ String func() string

+ func Chroot(root string, fs VFS) (VFS, error)

+ func FS(root string) (VFS, error)

+ func Map(files map[string]*File) (VFS, error)

+ func Memory() VFS

+ func Open(filename string) (VFS, error)

+ func ReadOnly(fs VFS) VFS

+ func Rewriter(fs VFS, rewriter func(oldPath string) (newPath string)) VFS

+ func Tar(r io.Reader) (VFS, error)

+ func TarBzip2(r io.Reader) (VFS, error)

+ func TarGzip(r io.Reader) (VFS, error)

+ func Zip(r io.Reader, size int64) (VFS, error)

+ type WFile interface

+ func NewWFile(f *File, read bool, write bool) (WFile, error)

+ type WalkFunc func(fs VFS, path string, info os.FileInfo, err error) error