homedir

Documentation

Index

• Variables
• func Dir() (string, error)
• func Expand(path string) (string, error)
• func MustExpand(path string) string

Variables

var DisableCache bool

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

var ErrNoHomeDir = errors.New("no home directory available")

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 MustExpand

func MustExpand(path string) string