fsutil

Documentation

Overview

Package fsutil provides filesystem utility functions for the application.

Index

• func CopyFile(srcpath, dstpath string) (err error)
• func DirExists(path string) (bool, error)
• func EmptyDir(path string) error
• func EnsureDir(path string) error
• func EnsureDirAll(path string) error
• func FileExists(path string) (bool, error)
• func FindInPaths(paths []string, baseName string) string
• func GetExeName(base string) string
• func GetHomeDirectory() string
• func GetIntraDir(pattern string, depth, length int) string
• func GetNameFromPath(path string, stripExtension bool) string
• func GetWorkingDirectory() string
• func IsFsPathCaseSensitive(path string) (bool, error)
• func IsPathInDir(dir, pathToCheck string) bool
• func IsPathInDirs(dirs []string, pathToCheck string) bool
• func MatchExtension(path string, extensions []string) bool
• func RemoveDir(path string) error
• func SafeMove(src, dst string) error
• func SanitiseBasename(v string) string
• func SymWalk(path string, walkFn filepath.WalkFunc) error
• func Touch(path string) error
• func WriteFile(path string, file []byte) error
• type Cancellable
• type LockContext
  • func (c *LockContext) AttachCommand(cmd *exec.Cmd)
  • func (c *LockContext) Cancel()
• type ReadLockManager
  • func NewReadLockManager() *ReadLockManager
  • func (m *ReadLockManager) Cancel(fn string)
  • func (m *ReadLockManager) ReadLock(ctx context.Context, fn string) *LockContext

Functions

func CopyFile

func CopyFile(srcpath, dstpath string) (err error)

CopyFile copies the contents of the file at srcpath to a regular file at dstpath. It will copy the last modified timestamp If dstpath already exists the function will fail.

func DirExists

func DirExists(path string) (bool, error)

DirExists returns true if the given path exists and is a directory

func EmptyDir

func EmptyDir(path string) error

EmptyDir will recursively remove the contents of a directory at the given path

func EnsureDir

func EnsureDir(path string) error

EnsureDir will create a directory at the given path if it doesn't already exist

func EnsureDirAll

func EnsureDirAll(path string) error

EnsureDirAll will create a directory at the given path along with any necessary parents if they don't already exist

func FileExists

func FileExists(path string) (bool, error)

FileExists returns true if the given path exists and is a file. This function returns false and the error encountered if the call to os.Stat fails.

func FindInPaths

func FindInPaths(paths []string, baseName string) string

FindInPaths returns the path to baseName in the first path where it exists from paths.

func GetExeName

func GetExeName(base string) string

GetExeName returns the name of the given executable for the current platform. One windows it returns the name with the .exe extension.

func GetHomeDirectory

func GetHomeDirectory() string

GetHomeDirectory returns the path of the user's home directory. ~ on Unix and C:\Users\UserName on Windows

func GetIntraDir

func GetIntraDir(pattern string, depth, length int) string

GetIntraDir returns a string that can be added to filepath.Join to implement directory depth, "" on error eg given a pattern of 0af63ce3c99162e9df23a997f62621c5 and a depth of 2 length of 3 returns 0af/63c or 0af\63c ( dependin on os) that can be later used like this filepath.Join(directory, intradir, basename)

func GetNameFromPath

func GetNameFromPath(path string, stripExtension bool) string

GetNameFromPath returns the name of a file from its path if stripExtension is true the extension is omitted from the name

func GetWorkingDirectory

func GetWorkingDirectory() string

GetWorkingDirectory returns the current working directory.

func IsFsPathCaseSensitive

func IsFsPathCaseSensitive(path string) (bool, error)

IsFsPathCaseSensitive checks the fs of the given path to see if it is case sensitive if the case sensitivity can not be determined false and an error != nil are returned

func IsPathInDir

func IsPathInDir(dir, pathToCheck string) bool

IsPathInDir returns true if pathToCheck is within dir.

func IsPathInDirs

func IsPathInDirs(dirs []string, pathToCheck string) bool

IsPathInDirs returns true if pathToCheck is within anys of the paths in dirs.

func MatchExtension

func MatchExtension(path string, extensions []string) bool

MatchExtension returns true if the extension of the provided path matches any of the provided extensions.

func RemoveDir

func RemoveDir(path string) error

RemoveDir removes the given dir (if it exists) along with all of its contents

func SafeMove

func SafeMove(src, dst string) error

SafeMove attempts to move the file with path src to dest using os.Rename. If this fails, then it copies src to dest, then deletes src. If the copy fails, or the delete fails, the function will return an error.

func SanitiseBasename

func SanitiseBasename(v string) string

SanitiseBasename returns a file basename removing any characters that are illegal or problematic to use in the filesystem.

func SymWalk

func SymWalk(path string, walkFn filepath.WalkFunc) error

SymWalk extends filepath.Walk to also follow symlinks

func Touch

func Touch(path string) error

Touch creates an empty file at the given path if it doesn't already exist

func WriteFile

func WriteFile(path string, file []byte) error

WriteFile writes file to path creating parent directories if needed

Types

type Cancellable

type Cancellable interface {
	Cancel()
}

type LockContext

type LockContext struct {
	context.Context
	// contains filtered or unexported fields
}

func (*LockContext) AttachCommand

func (c *LockContext) AttachCommand(cmd *exec.Cmd)

func (*LockContext) Cancel

func (c *LockContext) Cancel()

type ReadLockManager

type ReadLockManager struct {
	// contains filtered or unexported fields
}

ReadLockManager manages read locks on file paths.

func NewReadLockManager

func NewReadLockManager() *ReadLockManager

NewReadLockManager creates a new ReadLockManager.

func (*ReadLockManager) Cancel

func (m *ReadLockManager) Cancel(fn string)

Cancel cancels all read lock contexts associated with fn.

func (*ReadLockManager) ReadLock

func (m *ReadLockManager) ReadLock(ctx context.Context, fn string) *LockContext

ReadLock adds a pending file read lock for fn to its storage, returning a context and cancel function. Per standard WithCancel usage, cancel must be called when the lock is freed.