util

Documentation

Index

• Variables
• func RemoveAll(fs billy.Basic, path string) error
• func TempFile(fs billy.Basic, dir, prefix string) (billy.File, error)
• func WriteFile(fs billy.Basic, filename string, data []byte, perm os.FileMode) error

Variables

var (
	MaxTempFiles int32 = 1024 * 4
)

Functions

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 TempFile

func TempFile(fs billy.Basic, dir, prefix string) (billy.File, 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 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.