fileutil

Documentation

Index

• Variables
• func CWD() (string, error)
• func CacheFile(filename string) (string, error)
• func ConfigFile(filename string) (string, error)
• func CreateIfNotExist(f string) error
• func DefaultHomeDir(path ...string) string
• func DirExists(filename string) (bool, error)
• func DownloadOrUpdateGitRepo(url string) (path string, err error)
• func EnvdHomeDir(path ...string) string
• func FileExists(filename string) (bool, error)
• func FindFileAbsPath(path, fileName string) (string, error)
• func GetRandomName(retry int) string
• func RemoveAll(dirname string) error
• func RootDir() (string, error)

Variables

var (
	DefaultConfigDir  string
	DefaultCacheDir   string
	DefaultEnvdLibDir string
)

Functions

func CWD

func CWD() (string, error)

func CacheFile

func CacheFile(filename string) (string, error)

CacheFile returns the location for the specified envd cache file

func ConfigFile

func ConfigFile(filename string) (string, error)

ConfigFile returns the location for the specified envd config file

func CreateIfNotExist

func CreateIfNotExist(f string) error

func DefaultHomeDir

func DefaultHomeDir(path ...string) string

DefaultHomeDir returns the default user path inside the environment

func DirExists

func DirExists(filename string) (bool, error)

DirExists returns true if the directory exists.

func DownloadOrUpdateGitRepo

func DownloadOrUpdateGitRepo(url string) (path string, err error)

DownloadOrUpdateGitRepo downloads (if not exist) or update (if exist)

func EnvdHomeDir

func EnvdHomeDir(path ...string) string

EnvdHomeDir returns the envd user path inside the environment

func FileExists

func FileExists(filename string) (bool, error)

FileExists returns true if the file exists

func FindFileAbsPath

func FindFileAbsPath(path, fileName string) (string, error)

FindFileAbsPath returns the absolute path for the given path and file

func GetRandomName

func GetRandomName(retry int) string

GetRandomName generates a random name from the list of adjectives and surnames in this package formatted as "adjective_surname". For example 'focused_turing'. If retry is non-zero, a random integer between 0 and 10 will be added to the end of the name, e.g `focused_turing3`

func RemoveAll

func RemoveAll(dirname string) error

func RootDir

func RootDir() (string, error)