filesystem

Documentation

Overview

Content managed by Project Forge, see [projectforge.md] for details.

Content managed by Project Forge, see [projectforge.md] for details.

Content managed by Project Forge, see [projectforge.md] for details.

Content managed by Project Forge, see [projectforge.md] for details.

Content managed by Project Forge, see [projectforge.md] for details.

Content managed by Project Forge, see [projectforge.md] for details.

Content managed by Project Forge, see [projectforge.md] for details.

Index

• Variables
• type FileLoader
• type FileSystem
  • func NewFileSystem(root string) *FileSystem
  • func (f *FileSystem) Clone() FileLoader
  • func (f *FileSystem) CopyFile(src string, tgt string) error
  • func (f *FileSystem) CopyRecursive(src string, tgt string, ignore []string, logger util.Logger) error
  • func (f *FileSystem) CreateDirectory(path string) error
  • func (f *FileSystem) Exists(path string) bool
  • func (f *FileSystem) IsDir(path string) bool
  • func (f *FileSystem) ListDirectories(path string, ign []string, logger util.Logger) []string
  • func (f *FileSystem) ListExtension(path string, ext string, ign []string, trimExtension bool, logger util.Logger) []string
  • func (f *FileSystem) ListFiles(path string, ign []string, logger util.Logger) []os.DirEntry
  • func (f *FileSystem) ListFilesRecursive(path string, ign []string, _ util.Logger) ([]string, error)
  • func (f *FileSystem) ListJSON(path string, ign []string, trimExtension bool, logger util.Logger) []string
  • func (f *FileSystem) Move(src string, tgt string) error
  • func (f *FileSystem) PeekFile(path string, maxSize int) ([]byte, error)
  • func (f *FileSystem) ReadFile(path string) ([]byte, error)
  • func (f *FileSystem) Remove(path string, logger util.Logger) error
  • func (f *FileSystem) RemoveRecursive(path string, logger util.Logger) error
  • func (f *FileSystem) Root() string
  • func (f *FileSystem) SetMode(path string, mode os.FileMode) error
  • func (f *FileSystem) Stat(path string) (os.FileInfo, error)
  • func (f *FileSystem) Walk(path string, ign []string, ...) error
  • func (f *FileSystem) WriteFile(path string, content []byte, mode os.FileMode, overwrite bool) error

Variables

var (
	DirectoryMode = os.FileMode(0o755)
	DefaultMode   = os.FileMode(0o644)
)

Types

type FileLoader

type FileLoader interface {
	Root() string
	Clone() FileLoader
	PeekFile(path string, maxSize int) ([]byte, error)
	ReadFile(path string) ([]byte, error)
	CreateDirectory(path string) error
	WriteFile(path string, content []byte, mode os.FileMode, overwrite bool) error
	CopyFile(src string, tgt string) error
	CopyRecursive(src string, tgt string, ignore []string, logger util.Logger) error
	Move(src string, tgt string) error
	ListFiles(path string, ignore []string, logger util.Logger) []os.DirEntry
	ListFilesRecursive(path string, ignore []string, logger util.Logger) ([]string, error)
	ListJSON(path string, ignore []string, trimExtension bool, logger util.Logger) []string
	ListExtension(path string, ext string, ignore []string, trimExtension bool, logger util.Logger) []string
	ListDirectories(path string, ignore []string, logger util.Logger) []string
	Walk(path string, ign []string, fn func(fp string, info os.FileInfo, err error) error) error
	Stat(path string) (os.FileInfo, error)
	SetMode(path string, mode os.FileMode) error
	Exists(path string) bool
	IsDir(path string) bool
	Remove(path string, logger util.Logger) error
	RemoveRecursive(pt string, logger util.Logger) error
}

type FileSystem

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

func NewFileSystem

func NewFileSystem(root string) *FileSystem

func (*FileSystem) Clone

func (f *FileSystem) Clone() FileLoader

func (*FileSystem) CopyFile

func (f *FileSystem) CopyFile(src string, tgt string) error

func (*FileSystem) CopyRecursive

func (f *FileSystem) CopyRecursive(src string, tgt string, ignore []string, logger util.Logger) error

func (*FileSystem) CreateDirectory

func (f *FileSystem) CreateDirectory(path string) error

func (*FileSystem) Exists

func (f *FileSystem) Exists(path string) bool

func (*FileSystem) IsDir

func (f *FileSystem) IsDir(path string) bool

func (*FileSystem) ListDirectories

func (f *FileSystem) ListDirectories(path string, ign []string, logger util.Logger) []string

func (*FileSystem) ListExtension

func (f *FileSystem) ListExtension(path string, ext string, ign []string, trimExtension bool, logger util.Logger) []string

func (*FileSystem) ListFiles

func (f *FileSystem) ListFiles(path string, ign []string, logger util.Logger) []os.DirEntry

func (*FileSystem) ListFilesRecursive

func (f *FileSystem) ListFilesRecursive(path string, ign []string, _ util.Logger) ([]string, error)

func (*FileSystem) ListJSON

func (f *FileSystem) ListJSON(path string, ign []string, trimExtension bool, logger util.Logger) []string

func (*FileSystem) Move

func (f *FileSystem) Move(src string, tgt string) error

func (*FileSystem) PeekFile

func (f *FileSystem) PeekFile(path string, maxSize int) ([]byte, error)

func (*FileSystem) ReadFile

func (f *FileSystem) ReadFile(path string) ([]byte, error)

func (*FileSystem) Remove

func (f *FileSystem) Remove(path string, logger util.Logger) error

func (*FileSystem) RemoveRecursive

func (f *FileSystem) RemoveRecursive(path string, logger util.Logger) error

func (*FileSystem) Root

func (f *FileSystem) Root() string

func (*FileSystem) SetMode

func (f *FileSystem) SetMode(path string, mode os.FileMode) error

func (*FileSystem) Stat

func (f *FileSystem) Stat(path string) (os.FileInfo, error)

func (*FileSystem) Walk

func (f *FileSystem) Walk(path string, ign []string, fn func(fp string, info os.FileInfo, err error) error) error

func (*FileSystem) WriteFile

func (f *FileSystem) WriteFile(path string, content []byte, mode os.FileMode, overwrite bool) error