fs

Documentation

Index

• func AppendToFile(filePath string, text string) error
• func CopyAll(srcDirPath, dstDirPath string, skipFileSuffix string) (err error)
• func CopyFile(source string, destination string) error
• func EnsureDirExists(dirpath string) (err error)
• func TempDir(dir string, prefix string) (string, error)
• type OSUtil
  • func (fs OSUtil) AppendOrCreate(filePath string, text string) error
  • func (fs OSUtil) Copy(source string, destination string) error
  • func (fs OSUtil) CopyAll(source string, destination string) error
  • func (fs OSUtil) Mkdirs(dir string) error
  • func (fs OSUtil) OpenAndReadFile(file string) ([]byte, error)
  • func (fs OSUtil) TempDir(dir string, prefix string) (string, error)
• type Util

Functions

func AppendToFile

func AppendToFile(filePath string, text string) error

AppendToFile adds text to a file

func CopyAll

func CopyAll(srcDirPath, dstDirPath string, skipFileSuffix string) (err error)

CopyAll copies all files and directories inside `srcDirPath` to `dstDirPath`. Based on the CopyAll function from metaleap/go-utils

func CopyFile

func CopyFile(source string, destination string) error

CopyFile copys a file from source to destination

func EnsureDirExists

func EnsureDirExists(dirpath string) (err error)

EnsureDirExists makes sure that the directory exists

func TempDir

func TempDir(dir string, prefix string) (string, error)

TempDir creates a temporary directory

Types

type OSUtil

type OSUtil struct {
}

OSUtil is the struct for dealing with File System Operations on the disk.

func (OSUtil) AppendOrCreate

func (fs OSUtil) AppendOrCreate(filePath string, text string) error

AppendOrCreate adds text to file if it exists otherwise it creates a new file with the given text

func (OSUtil) Copy

func (fs OSUtil) Copy(source string, destination string) error

Copy copies one file from source to destination

func (OSUtil) CopyAll

func (fs OSUtil) CopyAll(source string, destination string) error

CopyAll copies recursively from source to destination

func (OSUtil) Mkdirs

func (fs OSUtil) Mkdirs(dir string) error

Mkdirs ensures that the directory is created.

func (OSUtil) OpenAndReadFile

func (fs OSUtil) OpenAndReadFile(file string) ([]byte, error)

OpenAndReadFile is a util that will check if the file exists, open and then read the file.

func (OSUtil) TempDir

func (fs OSUtil) TempDir(dir string, prefix string) (string, error)

TempDir creates a temp directory that the user is responsible for cleaning up

type Util

type Util interface {
	OpenAndReadFile(file string) ([]byte, error)
	CopyAll(source string, destination string) error
	Copy(source string, destination string) error
	TempDir(dir string, prefix string) (string, error)
	Mkdirs(dir string) error
	AppendOrCreate(filePath string, text string) error
}

Util is an interface for helper file system utilities.