Documentation ¶
Index ¶
- type DefaultFs
- func (f DefaultFs) Chmod(name string, mode os.FileMode) error
- func (DefaultFs) Chtimes(name string, atime time.Time, mtime time.Time) error
- func (DefaultFs) Create(name string) (File, error)
- func (DefaultFs) Getwd() (dir string, err error)
- func (DefaultFs) MkdirAll(path string, perm os.FileMode) error
- func (DefaultFs) Open(name string) (File, error)
- func (DefaultFs) OpenFile(name string, flag int, perm os.FileMode) (File, error)
- func (DefaultFs) ReadDir(dirname string) ([]os.FileInfo, error)
- func (DefaultFs) ReadFile(filename string) ([]byte, error)
- func (DefaultFs) Remove(name string) error
- func (DefaultFs) RemoveAll(path string) error
- func (DefaultFs) Rename(oldpath, newpath string) error
- func (DefaultFs) Stat(name string) (os.FileInfo, error)
- func (DefaultFs) TempDir(dir, prefix string) (string, error)
- func (DefaultFs) TempFile(dir, prefix string) (File, error)
- func (DefaultFs) Walk(root string, walkFn filepath.WalkFunc) error
- func (DefaultFs) WriteFile(filename string, data []byte, perm os.FileMode) error
- type FSErrorHandler
- type FSEventHandler
- type FSWatcher
- type File
- type Filesystem
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type DefaultFs ¶
type DefaultFs struct{}
DefaultFs implements Filesystem using same-named functions from "os" and "io/ioutil"
type FSErrorHandler ¶ added in v1.3.0
type FSErrorHandler func(err error)
FSErrorHandler is called when a fsnotify error occurs.
type FSEventHandler ¶ added in v1.3.0
FSEventHandler is called when a fsnotify event occurs.
type FSWatcher ¶ added in v1.3.0
type FSWatcher interface { // Initializes the watcher with the given watch handlers. // Called before all other methods. Init(FSEventHandler, FSErrorHandler) error // Starts listening for events and errors. // When an event or error occurs, the corresponding handler is called. Run() // Add a filesystem path to watch AddWatch(path string) error }
FSWatcher is a callback-based filesystem watcher abstraction for fsnotify.
type File ¶
type File interface { // for now, the only os.File methods used are those below, add more as necessary Name() string Write(b []byte) (n int, err error) WriteString(s string) (n int, err error) Sync() error Close() error Read(b []byte) (n int, err error) Readdir(n int) ([]os.FileInfo, error) }
File is an interface that we can use to mock various filesystem operations typically accessed through the File object from the "os" package
type Filesystem ¶
type Filesystem interface { // from "os" Stat(name string) (os.FileInfo, error) Create(name string) (File, error) Open(name string) (File, error) OpenFile(name string, flag int, perm os.FileMode) (File, error) Rename(oldpath, newpath string) error MkdirAll(path string, perm os.FileMode) error Chtimes(name string, atime time.Time, mtime time.Time) error RemoveAll(path string) error Remove(name string) error Chmod(name string, mode os.FileMode) error Getwd() (dir string, err error) // from "io/ioutil" ReadFile(filename string) ([]byte, error) WriteFile(filename string, data []byte, perm os.FileMode) error TempDir(dir, prefix string) (string, error) TempFile(dir, prefix string) (File, error) ReadDir(dirname string) ([]os.FileInfo, error) Walk(root string, walkFn filepath.WalkFunc) error }
Filesystem is an interface that we can use to mock various filesystem operations
func Get ¶ added in v1.3.0
func Get() Filesystem
func NewFakeFs ¶
func NewFakeFs() Filesystem
NewFakeFs returns a fake Filesystem that exists in-memory, useful for unit tests
Click to show internal directories.
Click to hide internal directories.