fs

Documentation

Overview

Package fs provides filesystem related functionality.

Index

• func CopyAll(dstdir, srcdir string) error
• func CopyDir(destdir, srcdir string, filter CopyFilterFunc) error
• type CopyFilterFunc
• type ListResult
  • func ListTerramateFiles(dir string) (ListResult, error)

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.

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
}

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)