OverlayFile is the -overlay flag value. It names a file containing the JSON for an overlayJSON struct.
var OverlayFile string
func Actual(name string) string
Actual returns the actual file system path for the named file. It returns the empty string if name has been deleted in the virtual file system.
func Bind(dir, mtpt string)
Bind makes the virtual file system use dir as if it were mounted at mtpt, like Plan 9's “bind” or Linux's “mount --bind”, or like os.Symlink but without the symbolic link.
For now, the behavior of using Bind on multiple overlapping mountpoints (for example Bind("x", "/a") and Bind("y", "/a/b")) is undefined.
func Glob(pattern string) (matches []string, err error)
Glob is like filepath.Glob but uses the overlay file system.
func Init() error
Init initializes the overlay, if one is being used.
func IsDir(path string) (bool, error)
IsDir returns true if path is a directory on disk or in the overlay.
func IsGoDir(name string) (bool, error)
IsGoDir reports whether the named directory in the virtual file system is a directory containing one or more Go source files.
func Lstat(name string) (fs.FileInfo, error)
Lstat returns a FileInfo describing the named file in the virtual file system. It does not follow symbolic links
func Open(name string) (*os.File, error)
Open opens the named file in the virtual file system. It must be an ordinary file, not a directory.
func ReadDir(name string) ([]fs.DirEntry, error)
ReadDir reads the named directory in the virtual file system.
func ReadFile(name string) ([]byte, error)
ReadFile reads the named file from the virtual file system and returns the contents.
func Replaced(name string) bool
Replaced reports whether the named file has been modified in the virtual file system compared to the OS file system.
func Stat(name string) (fs.FileInfo, error)
Stat returns a FileInfo describing the named file in the virtual file system. It follows symbolic links.
func Trace(op, path string)
Trace emits a trace event for the operation and file path to the trace log, but only when $GODEBUG contains gofsystrace=1. The traces are appended to the file named by the $GODEBUG setting gofsystracelog, or else standard error. For debugging, if the $GODEBUG setting gofsystracestack is non-empty, then trace events for paths matching that glob pattern (using path.Match) will be followed by a full stack trace.
func WalkDir(root string, fn fs.WalkDirFunc) error
WalkDir is like filepath.WalkDir but over the virtual file system.