fs

Documentation

Index

• type DefaultFs
  • func New() *DefaultFs
  • func NewWithRootPath(rootPath string) *DefaultFs
  • func (fs *DefaultFs) Chtimes(name string, atime time.Time, mtime time.Time) error
  • func (fs *DefaultFs) Create(name string) (File, error)
  • func (fs *DefaultFs) MkdirAll(path string, perm os.FileMode) error
  • func (fs *DefaultFs) ReadFile(filename string) ([]byte, error)
  • func (fs *DefaultFs) Remove(name string) error
  • func (fs *DefaultFs) RemoveAll(path string) error
  • func (fs *DefaultFs) Rename(oldpath, newpath string) error
  • func (fs *DefaultFs) Stat(name string) (os.FileInfo, error)
  • func (fs *DefaultFs) Walk(root string, walkFn filepath.WalkFunc) error
  • func (fs *DefaultFs) WriteFile(filename string, data []byte, perm fs.FileMode) error
• type File
• type Fs

Types

type DefaultFs

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

DefaultFs implements Filesystem using same-named functions from "os" and "path/filepath"

func New

func New() *DefaultFs

NewTempFs returns a fake Filesystem in temporary directory, useful for unit tests

func NewWithRootPath

func NewWithRootPath(rootPath string) *DefaultFs

NewTempFs returns a fake Filesystem in temporary directory, useful for unit tests

func (*DefaultFs) Chtimes

func (fs *DefaultFs) Chtimes(name string, atime time.Time, mtime time.Time) error

Chtimes via os.Chtimes

func (*DefaultFs) Create

func (fs *DefaultFs) Create(name string) (File, error)

Create via os.Create

func (*DefaultFs) MkdirAll

func (fs *DefaultFs) MkdirAll(path string, perm os.FileMode) error

MkdirAll via os.MkdirAll

func (*DefaultFs) ReadFile

func (fs *DefaultFs) ReadFile(filename string) ([]byte, error)

ReadFile via os.ReadFile

func (*DefaultFs) Remove

func (fs *DefaultFs) Remove(name string) error

Remove via os.RemoveAll

func (*DefaultFs) RemoveAll

func (fs *DefaultFs) RemoveAll(path string) error

RemoveAll via os.RemoveAll

func (*DefaultFs) Rename

func (fs *DefaultFs) Rename(oldpath, newpath string) error

Rename via os.Rename

func (*DefaultFs) Stat

func (fs *DefaultFs) Stat(name string) (os.FileInfo, error)

Stat via os.Stat

func (*DefaultFs) Walk

func (fs *DefaultFs) Walk(root string, walkFn filepath.WalkFunc) error

Walk via filepath.Walk

func (*DefaultFs) WriteFile

func (fs *DefaultFs) WriteFile(filename string, data []byte, perm fs.FileMode) error

WriteFile via os.WriteFile

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)
	Sync() error
	Close() 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 Fs

type Fs interface {
	// from "os"
	Stat(name string) (os.FileInfo, error)
	Create(name string) (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
	ReadFile(filename string) ([]byte, error)
	WriteFile(filename string, data []byte, perm fs.FileMode) error

	// from "path/filepath"
	Walk(root string, walkFn filepath.WalkFunc) error
}

Filesystem is an interface that we can use to mock various filesystem operations