util

Documentation

Index

• func Glob(fs billy.Filesystem, pattern string) (matches []string, err error)
• func ReadFile(fs billy.Basic, name string) ([]byte, error)
• func RemoveAll(fs billy.Basic, path string) error
• func TempDir(fs billy.Dir, dir, prefix string) (name string, err error)
• func TempFile(fs billy.Basic, dir, prefix string) (f billy.File, err error)
• func Walk(fs billy.Filesystem, root string, walkFn filepath.WalkFunc) error
• func WriteFile(fs billy.Basic, filename string, data []byte, perm os.FileMode) error

Functions

func Glob

func Glob(fs billy.Filesystem, pattern string) (matches []string, err error)

Glob returns the names of all files matching pattern or nil if there is no matching file. The syntax of patterns is the same as in Match. The pattern may describe hierarchical names such as /usr/*/bin/ed (assuming the Separator is '/').

Glob ignores file system errors such as I/O errors reading directories. The only possible returned error is ErrBadPattern, when pattern is malformed.

Function originally from https://golang.org/src/path/filepath/match_test.go

func ReadFile

func ReadFile(fs billy.Basic, name string) ([]byte, error)

ReadFile reads the named file and returns the contents from the given filesystem. A successful call returns err == nil, not err == EOF. Because ReadFile reads the whole file, it does not treat an EOF from Read as an error to be reported.

func RemoveAll

func RemoveAll(fs billy.Basic, path string) error

RemoveAll removes path and any children it contains. It removes everything it can but returns the first error it encounters. If the path does not exist, RemoveAll returns nil (no error).

func TempDir

func TempDir(fs billy.Dir, dir, prefix string) (name string, err error)

TempDir creates a new temporary directory in the directory dir with a name beginning with prefix and returns the path of the new directory. If dir is the empty string, TempDir uses the default directory for temporary files (see os.TempDir). Multiple programs calling TempDir simultaneously will not choose the same directory. It is the caller's responsibility to remove the directory when no longer needed.

func TempFile

func TempFile(fs billy.Basic, dir, prefix string) (f billy.File, err error)

TempFile creates a new temporary file in the directory dir with a name beginning with prefix, opens the file for reading and writing, and returns the resulting *os.File. If dir is the empty string, TempFile uses the default directory for temporary files (see os.TempDir). Multiple programs calling TempFile simultaneously will not choose the same file. The caller can use f.Name() to find the pathname of the file. It is the caller's responsibility to remove the file when no longer needed.

func Walk

func Walk(fs billy.Filesystem, root string, walkFn filepath.WalkFunc) error

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

The files are walked in lexical order, which makes the output deterministic but requires Walk to read an entire directory into memory before proceeding to walk that directory. Walk does not follow symbolic links.

Function adapted from https://github.com/golang/go/blob/3b770f2ccb1fa6fecc22ea822a19447b10b70c5c/src/path/filepath/path.go#L500

func WriteFile

func WriteFile(fs billy.Basic, filename string, data []byte, perm os.FileMode) error

WriteFile writes data to a file named by filename in the given filesystem. If the file does not exist, WriteFile creates it with permissions perm; otherwise WriteFile truncates it before writing.