localfs

Documentation

Index

• func MkdirAllReset(path string, perm fs.FileMode) error
• func Save(f fs.FS, path string) error
• func SaveBytesTemp(data []byte, prefix string, perm os.FileMode) (path string, cleanup func(), err error)
• func SaveTemp(f fs.FS) (path string, cleanup func(), err error)
• func Search(path, pattern string) ([]string, error)
• func Watch(ctx context.Context, paths []string, options ...WatcherOption) error
• type WatcherOption
  • func WatcherIgnoreExt(exts ...string) WatcherOption
  • func WatcherIgnoreHidden() WatcherOption
  • func WatcherOnChange(hook func()) WatcherOption
  • func WatcherPollingInterval(d time.Duration) WatcherOption
  • func WatcherWorkdir(path string) WatcherOption

Functions

func MkdirAllReset

func MkdirAllReset(path string, perm fs.FileMode) error

MkdirAllReset is same as os.MkdirAll except it deletes path before creating it.

func Save

func Save(f fs.FS, path string) error

Save saves file system f to path in the local file system.

func SaveBytesTemp

func SaveBytesTemp(data []byte, prefix string, perm os.FileMode) (path string, cleanup func(), err error)

SaveBytesTemp saves data bytes to a temporary file location at path.

func SaveTemp

func SaveTemp(f fs.FS) (path string, cleanup func(), err error)

SaveTemp saves file system f to a temporary path in the local file system and returns that path.

func Search

func Search(path, pattern string) ([]string, error)

Search searches for files in the fs with given glob pattern by ensuring that returned file paths are sorted.

func Watch

func Watch(ctx context.Context, paths []string, options ...WatcherOption) error

Watch starts watching changes on the paths. options are used to configure the behaviour of watch operation.

Types

type WatcherOption

type WatcherOption func(*watcher)

WatcherOption used to configure watcher.

func WatcherIgnoreExt

func WatcherIgnoreExt(exts ...string) WatcherOption

WatcherIgnoreExt ignores files with matching file extensions.

func WatcherIgnoreHidden

func WatcherIgnoreHidden() WatcherOption

WatcherIgnoreHidden ignores hidden(dot) files.

func WatcherOnChange

func WatcherOnChange(hook func()) WatcherOption

WatcherOnChange sets a hook that executed on every change on filesystem.

func WatcherPollingInterval

func WatcherPollingInterval(d time.Duration) WatcherOption

WatcherPollingInterval overwrites default polling interval to check filesystem changes.

func WatcherWorkdir

func WatcherWorkdir(path string) WatcherOption

WatcherWorkdir to set as a root to paths needs to be watched.