README
¶
dirset
Package dirset provides discovery of common application directories for things like caching, locks, and logs.
import go.pitz.tech/lib/dirset
Usage
type DirectorySet
type DirectorySet struct {
CacheDir string
StateDir string
LocalStateDir string
LockDir string
LogDir string
}
DirectorySet defines a common set of paths that applications can use for a variety of reasons.
func Local
func Local(appName string) (DirectorySet, error)
Local uses information about the local system to determine a common set of paths for use by the application.
func Must
func Must(appName string) DirectorySet
Must panics if Local fails to obtain the directory set.
Documentation
¶
Overview ¶
Package dirset provides discovery of common application directories for things like caching, locks, and logs.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type DirectorySet ¶
type DirectorySet struct {
CacheDir string
StateDir string
LocalStateDir string
LockDir string
LogDir string
}
DirectorySet defines a common set of paths that applications can use for a variety of reasons.
func Local ¶
func Local(appName string) (DirectorySet, error)
Local uses information about the local system to determine a common set of paths for use by the application.
func Must ¶
func Must(appName string) DirectorySet
Must panics if Local fails to obtain the directory set.
Source Files