host

Documentation

Index

• Variables
• func HomeDir() (string, error)
• func HomeExpand(path string) (string, error)
• func HomeReset()
• func PrimaryIP() (string, error)

Variables

var DisableCache bool

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

Functions

func HomeDir

func HomeDir() (string, error)

HomeDir 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 HomeExpand

func HomeExpand(path string) (string, error)

HomeExpand 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 HomeReset

func HomeReset()

HomeReset clears the cache, forcing the next call to Dir to re-detect the home directory. This generally never has to be called, but can be useful in tests if you're modifying the home directory via the HOME env var or something.

func PrimaryIP

func PrimaryIP() (string, error)

PrimaryIP of current host.