helpers

Documentation

Index

• Variables
• func BaseConfigPath() string
• func CacheDir() string
• func EnsurePath(pathName string) error
• func FileExists(pathName string) bool
• func GetHome() string
• func InitLoggers(level log.Level)
• func LogPath() string
• func MetadataConfigPath() string
• func RandAlphaString(n int) string
• func UserCacheDir() (string, error)

Variables

var Version = "Unknown Version"

Functions

func BaseConfigPath

func BaseConfigPath() string

BaseConfigPath returns the root for our config folders.

func CacheDir

func CacheDir() string

CacheDir returns a cache folder to use.

func EnsurePath

func EnsurePath(pathName string) error

EnsurePath ensures the given filesystem path exists, if not it will create it.

func FileExists

func FileExists(pathName string) bool

FileExists checks whether a file or folder exists in the filesystem, will follow symlinks and ensures the target exists too.

func GetHome

func GetHome() string

GetHome returns the given users home folder

func InitLoggers

func InitLoggers(level log.Level)

InitLoggers sets the default logger options

func LogPath

func LogPath() string

LogPath returns the path to our logfolder.

func MetadataConfigPath

func MetadataConfigPath() string

MetadataConfigPath returns the config path for the md server

func RandAlphaString

func RandAlphaString(n int) string

func UserCacheDir

func UserCacheDir() (string, error)

UserCacheDir returns the default root directory to use for user-specific cached data. Users should create their own application-specific subdirectory within this one and use that.

On Unix systems, it returns $XDG_CACHE_HOME as specified by https://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html if non-empty, else $HOME/.cache. On Darwin, it returns $HOME/Library/Caches. On Windows, it returns %LocalAppData%. On Plan 9, it returns $home/lib/cache.

If the location cannot be determined (for example, $HOME is not defined), then it will return an error.