Documentation
¶
Index ¶
- func DirExists(fs utilfs.Filesystem, path string) (bool, error)
- func EnsureDir(fs utilfs.Filesystem, path string) error
- func EnsureFile(fs utilfs.Filesystem, path string) error
- func FileExists(fs utilfs.Filesystem, path string) (bool, error)
- func ReplaceDir(fs utilfs.Filesystem, path string, files map[string]string) error
- func ReplaceFile(fs utilfs.Filesystem, path string, data []byte) error
- func WriteTempDir(fs utilfs.Filesystem, path string, files map[string]string) (tmpPath string, retErr error)
- func WriteTmpFile(fs utilfs.Filesystem, path string, data []byte) (tmpPath string, retErr error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DirExists ¶
func DirExists(fs utilfs.Filesystem, path string) (bool, error)
DirExists returns true if a directory exists at `path`, false if `path` does not exist, otherwise an error
func EnsureDir ¶
func EnsureDir(fs utilfs.Filesystem, path string) error
EnsureDir ensures that a directory exists at `path`, and if it must create the directory any necessary parent directories will also be created and the new directory will be empty.
func EnsureFile ¶
func EnsureFile(fs utilfs.Filesystem, path string) error
EnsureFile ensures that a regular file exists at `path`, and if it must create the file any necessary parent directories will also be created and the new file will be empty.
func FileExists ¶
func FileExists(fs utilfs.Filesystem, path string) (bool, error)
FileExists returns true if a regular file exists at `path`, false if `path` does not exist, otherwise an error
func ReplaceDir ¶ added in v1.11.0
ReplaceDir replaces the contents of the dir at `path` with `files` by writing to a tmp dir in the same dir as `path` and renaming the tmp dir over `path`. The dir does not have to exist to use ReplaceDir.
func ReplaceFile ¶
func ReplaceFile(fs utilfs.Filesystem, path string, data []byte) error
ReplaceFile replaces the contents of the file at `path` with `data` by writing to a tmp file in the same dir as `path` and renaming the tmp file over `path`. The file does not have to exist to use ReplaceFile, but the parent directory must exist. Note ReplaceFile calls fsync.
func WriteTempDir ¶ added in v1.11.0
func WriteTempDir(fs utilfs.Filesystem, path string, files map[string]string) (tmpPath string, retErr error)
WriteTempDir creates a temporary dir at `path`, writes `files` into it, and fsyncs all the files The keys of `files` represent file names. These names must not: - be empty - be a path that contains more than the base name of a file (e.g. foo/bar is invalid, as is /bar) - match `.` or `..` exactly - be longer than 255 characters The above validation rules are based on atomic_writer.go, though in this case are more restrictive because we only allow a flat hierarchy.
func WriteTmpFile ¶ added in v1.9.0
WriteTmpFile creates a temporary file at `path`, writes `data` into it, and fsyncs the file Expects the parent directory to exist.
Types ¶
This section is empty.
Source Files