fs

Documentation

Overview

Package fs provides filesystem related functionality.

Index

• func CopyAll(dstdir, srcdir string) error
• func CopyDir(destdir, srcdir string, filter CopyFilterFunc) error
• func CopyFile(destfile, srcfile string) error
• type CopyFilterFunc
• type ListResult
  • func ListTerramateFiles(dir string) (ListResult, error)
  • func (r *ListResult) AddDir(name string)
  • func (r *ListResult) AddFile(name string)

Functions

func CopyAll

func CopyAll(dstdir, srcdir string) error

CopyAll copies all files from dstdir into srcdir.

func CopyDir

func CopyDir(destdir, srcdir string, filter CopyFilterFunc) error

CopyDir will copy srcdir to destdir. It will copy all dirs and files recursively. The destdir provided does not need to exist, it will be created. The provided filter function allows to filter which files/directories get copied.

func CopyFile

func CopyFile(destfile, srcfile string) error

CopyFile copies a file from srcfile to destfile.

Types

type CopyFilterFunc

type CopyFilterFunc func(path string, entry os.DirEntry) bool

CopyFilterFunc filters which files/dirs will be copied by CopyDir. If the function returns true, the file/dir is copied. If it returns false, the file/dir is ignored.

type ListResult

type ListResult struct {
	TmFiles    []string
	TmGenFiles []string
	OtherFiles []string
	Dirs       []string
	Skipped    []string
}

ListResult contains the result of listing a directory.

func ListTerramateFiles

func ListTerramateFiles(dir string) (ListResult, error)

ListTerramateFiles returns the entries of directory separated (terramate files, others and directories)

func (*ListResult) AddDir

func (r *ListResult) AddDir(name string)

AddDir adds a directory to the ListResult. It classifies the directory accordingly.

func (*ListResult) AddFile

func (r *ListResult) AddFile(name string)

AddFile adds a file to the ListResult. It classifies the file accordingly.