fileutil

Documentation

Overview

Package fileutil implements utility functions related to files and paths.

Index

• Variables
• func Exist(name string) bool
• func IsDirWriteable(dir string) error
• func Preallocate(f *os.File, sizeInBytes int) error
• func PurgeFile(dirname string, suffix string, max uint, interval time.Duration, ...) <-chan error
• func ReadDir(dirpath string) ([]string, error)
• func TouchDirAll(dir string) error
• type Lock
  • func NewLock(file string) (Lock, error)

Variables

var (
	ErrLocked = errors.New("file already locked")
)

Functions

func Exist

func Exist(name string) bool

func IsDirWriteable

func IsDirWriteable(dir string) error

IsDirWriteable checks if dir is writable by writing and removing a file to dir. It returns nil if dir is writable.

func Preallocate

func Preallocate(f *os.File, sizeInBytes int) error

Preallocate tries to allocate the space for given file. This operation is only supported on linux by a few filesystems (btrfs, ext4, etc.). If the operation is unsupported, no error will be returned. Otherwise, the error encountered will be returned.

func PurgeFile

func PurgeFile(dirname string, suffix string, max uint, interval time.Duration, stop <-chan struct{}) <-chan error

func ReadDir

func ReadDir(dirpath string) ([]string, error)

ReadDir returns the filenames in the given directory in sorted order.

func TouchDirAll

func TouchDirAll(dir string) error

TouchDirAll is similar to os.MkdirAll. It creates directories with 0700 permission if any directory does not exists. TouchDirAll also ensures the given directory is writable.

Types

type Lock

type Lock interface {
	Name() string
	TryLock() error
	Lock() error
	Unlock() error
	Destroy() error
}

func NewLock

func NewLock(file string) (Lock, error)