envutil

Documentation

Index

• Variables
• func Dir() (string, error)
• func Expand(path string) (string, error)
• func GetBoolEnvVarOrDefault(name string, defaultValue bool) bool
• func GetConfigDirs() []string
• func GetStringEnvVarOrEmptyString(name string) string

Variables

var DisableCache bool

DisableCache will disable caching of the home directory. Caching is enabled by default.

Functions

func Dir

func Dir() (string, error)

Dir returns the home directory for the executing user.

This uses an OS-specific method for discovering the home directory. An error is returned if a home directory cannot be detected.

func Expand

func Expand(path string) (string, error)

Expand expands the path to include the home directory if the path is prefixed with `~`. If it isn't prefixed with `~`, the path is returned as-is.

func GetBoolEnvVarOrDefault

func GetBoolEnvVarOrDefault(name string, defaultValue bool) bool

GetBoolEnvVarOrDefault returns the boolean value specified in the environmential variable identified as name, or it returns the specified default value if the environmential variable is not found.

func GetConfigDirs

func GetConfigDirs() []string

GetConfigDirs returns a list of location where configuration files can be located.

func GetStringEnvVarOrEmptyString

func GetStringEnvVarOrEmptyString(name string) string

GetStringEnvVarOrEmptyString returns a string value found in the specified environmential variable or it returns an empty string value.