fs

Documentation

Index

• func BaseName(path string) string
• func Copy(src, dst string) error
• func FileExists(path string) bool
• func IsDir(path string) bool
• func LoadJSON(path string, data interface{}) error
• func LoadYAML(path string, data interface{}) error
• func MoveFile(src, dst string) (err error)
• func SanitizeName(name string) string
• func SaveJSON(path string, data interface{}, format bool) error
• func SaveYAML(path string, data interface{}) error
• func Split(path string) []string
• func TrimExtension(path string) string
• 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 FileExists

func FileExists(path string) bool

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

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 interface{}) error

LoadJSON data from the specified path.

func LoadYAML

func LoadYAML(path string, data interface{}) error

LoadYAML data from the specified 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 interface{}, format bool) error

SaveJSON data to the specified path.

func SaveYAML

func SaveYAML(path string, data interface{}) error

SaveYAML data to the specified path.

func Split

func Split(path string) []string

Split a path into its component parts.

func TrimExtension

func TrimExtension(path string) string

TrimExtension trims any extension from the path.

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.