fs

Documentation

Overview

Package fs provides filesystem-related utilities.

Index

• func BaseName(path string) string
• func Copy(src, dst string) error
• func CopyWithMask(src, dst string, mask fs.FileMode) error
• func CreateTemp(dir, pattern string, perm os.FileMode) (*os.File, error)
• func FileExists(path string) bool
• func FileIsReadable(path string) bool
• func IsDir(path string) bool
• func LoadJSON(path string, data any) error
• func LoadJSONFromFS(fsys fs.FS, path string, data any) error
• func LoadYAML(path string, data any) error
• func LoadYAMLFromFS(fsys fs.FS, path string, data any) error
• func MoveFile(src, dst string) (err error)
• func SanitizeName(name string) string
• func SaveJSON(path string, data any, format bool) error
• func SaveJSONWithMode(path string, data any, format bool, mode os.FileMode) error
• func SaveYAML(path string, data any) error
• func SaveYAMLWithMode(path string, data any, mode os.FileMode) error
• func Split(path string) []string
• func TrimExtension(path string) string
• func UniquePaths(paths ...string) ([]string, error)
• func UnsanitizeName(name string) string
• func Walk(fs http.FileSystem, root string, walkFn filepath.WalkFunc) error

Functions

func BaseName

func BaseName(path string) string

BaseName returns the file name without the directory or extension.

func Copy

func Copy(src, dst string) error

Copy src to dst. src may be a directory, file, or symlink.

func CopyWithMask

func CopyWithMask(src, dst string, mask fs.FileMode) error

CopyWithMask src to dst. src may be a directory, file, or symlink.

func CreateTemp

func CreateTemp(dir, pattern string, perm os.FileMode) (*os.File, error)

CreateTemp is essentially the same as os.CreateTemp, except it allows you to specify the file mode of the newly created file.

func FileExists

func FileExists(path string) bool

FileExists returns true if the path points to a regular file.

func FileIsReadable

func FileIsReadable(path string) bool

FileIsReadable returns true if the path points to a regular file that we have permission to read.

func IsDir

func IsDir(path string) bool

IsDir returns true if the specified path exists and is a directory.

func LoadJSON

func LoadJSON(path string, data any) error

LoadJSON data from the specified path.

func LoadJSONFromFS

func LoadJSONFromFS(fsys fs.FS, path string, data any) error

LoadJSONFromFS data from the specified filesystem path.

func LoadYAML

func LoadYAML(path string, data any) error

LoadYAML data from the specified path.

func LoadYAMLFromFS

func LoadYAMLFromFS(fsys fs.FS, path string, data any) error

LoadYAMLFromFS data from the specified filesystem path.

func MoveFile

func MoveFile(src, dst string) (err error)

MoveFile moves a file in the file system or across volumes, using rename if possible, but falling back to copying the file if not. This will error if either src or dst are not regular files.

func SanitizeName

func SanitizeName(name string) string

SanitizeName sanitizes a file name by replacing invalid characters.

func SaveJSON

func SaveJSON(path string, data any, format bool) error

SaveJSON data to the specified path.

func SaveJSONWithMode

func SaveJSONWithMode(path string, data any, format bool, mode os.FileMode) error

SaveJSONWithMode data to the specified path.

func SaveYAML

func SaveYAML(path string, data any) error

SaveYAML data to the specified path.

func SaveYAMLWithMode

func SaveYAMLWithMode(path string, data any, mode os.FileMode) error

SaveYAMLWithMode data to the specified path.

func Split

func Split(path string) []string

Split a path into its component parts. In the case of a full path, the first element will be filepath.Separator, possibly prefixed by a volume name. In the case of a relative path, the first element will be ".".

func TrimExtension

func TrimExtension(path string) string

TrimExtension trims any extension from the path.

func UniquePaths

func UniquePaths(paths ...string) ([]string, error)

UniquePaths returns a list of unique paths from the given paths, pruning out paths that are a subset of another.

func UnsanitizeName

func UnsanitizeName(name string) string

UnsanitizeName reverses the effects of a call to SanitizeName.

func Walk

func Walk(fs http.FileSystem, root string, walkFn filepath.WalkFunc) error

Walk performs the same function as filepath.Walk() does, but works on http.FileSystem objects.