Documentation
¶
Index ¶
- Variables
- func SiteCacheDir(appname *string, appauthor any, version *string, opinion *bool, ...) string
- func SiteCachePath(appname *string, appauthor any, version *string, opinion *bool, ...) string
- func SiteConfigDir(appname *string, appauthor any, version *string, multipath *bool, ...) string
- func SiteConfigPath(appname *string, appauthor any, version *string, multipath *bool, ...) string
- func SiteDataDir(appname *string, appauthor any, version *string, multipath *bool, ...) string
- func SiteDataPath(appname *string, appauthor any, version *string, multipath *bool, ...) string
- func SiteRuntimeDir(appname *string, appauthor any, version *string, opinion *bool, ...) string
- func SiteRuntimePath(appname *string, appauthor any, version *string, opinion *bool, ...) string
- func UserCacheDir(appname *string, appauthor any, version *string, opinion *bool, ...) string
- func UserCachePath(appname *string, appauthor any, version *string, opinion *bool, ...) string
- func UserConfigDir(appname *string, appauthor any, version *string, roaming *bool, ...) string
- func UserConfigPath(appname *string, appauthor any, version *string, roaming *bool, ...) string
- func UserDataDir(appname *string, appauthor any, version *string, roaming *bool, ...) string
- func UserDataPath(appname *string, appauthor any, version *string, roaming *bool, ...) string
- func UserDesktopDir() string
- func UserDesktopPath() string
- func UserDocumentsDir() string
- func UserDocumentsPath() string
- func UserDownloadsDir() string
- func UserDownloadsPath() string
- func UserLogDir(appname *string, appauthor any, version *string, opinion *bool, ...) string
- func UserLogPath(appname *string, appauthor any, version *string, opinion *bool, ...) string
- func UserMusicDir() string
- func UserMusicPath() string
- func UserPicturesDir() string
- func UserPicturesPath() string
- func UserRuntimeDir(appname *string, appauthor any, version *string, opinion *bool, ...) string
- func UserRuntimePath(appname *string, appauthor any, version *string, opinion *bool, ...) string
- func UserStateDir(appname *string, appauthor any, version *string, roaming *bool, ...) string
- func UserStatePath(appname *string, appauthor any, version *string, roaming *bool, ...) string
- func UserVideosDir() string
- func UserVideosPath() string
- type AppDirs
- type PlatformDirs
Constants ¶
This section is empty.
Variables ¶
View Source
var Version = version.Version
View Source
var VersionInfo = version.VersionTuple
Functions ¶
func SiteCacheDir ¶
func SiteCachePath ¶
func SiteConfigDir ¶
func SiteConfigDir(appname *string, appauthor any, version *string, multipath *bool, ensureExists *bool) string
Params:
- appname: Optional. Default is nil. See github.com/jcbhmr/go-platformdirs/api.PlatformDirsABCImpl Appname.
- appauthor: Must be nil, string, or false. Optional. Default is nil. See github.com/jcbhmr/go-platformdirs/api.PlatformDirsABCImpl Appauthor.
- version: Optional. Default is nil. See github.com/jcbhmr/go-platformdirs/api.PlatformDirsABCImpl Version.
- multipath: Optional. Default is false. See github.com/jcbhmr/go-platformdirs/api.PlatformDirsABCImpl Multipath.
- ensureExists: Optional. Default is false. See github.com/jcbhmr/go-platformdirs/api.PlatformDirsABCImpl EnsureExists.
Returns: config directory shared by users
func SiteConfigPath ¶
func SiteDataDir ¶
func SiteDataDir(appname *string, appauthor any, version *string, multipath *bool, ensureExists *bool) string
Params:
- appname: Optional. Default is nil. See github.com/jcbhmr/go-platformdirs/api.PlatformDirsABCImpl Appname.
- appauthor: Must be nil, string, or false. Optional. Default is nil. See github.com/jcbhmr/go-platformdirs/api.PlatformDirsABCImpl Appauthor.
- version: Optional. Default is nil. See github.com/jcbhmr/go-platformdirs/api.PlatformDirsABCImpl Version.
- multipath: Optional. Default is false. See github.com/jcbhmr/go-platformdirs/api.PlatformDirsABCImpl Multipath.
- ensureExists: Optional. Default is false. See github.com/jcbhmr/go-platformdirs/api.PlatformDirsABCImpl EnsureExists.
Returns: configuration directory shared by users
func SiteDataPath ¶
func SiteRuntimeDir ¶
func SiteRuntimePath ¶
func UserCacheDir ¶
func UserCacheDir(appname *string, appauthor any, version *string, opinion *bool, ensureExists *bool) string
Params:
- appname: Optional. Default is nil. See github.com/jcbhmr/go-platformdirs/api.PlatformDirsABCImpl Appname.
- appauthor: Must be nil, string, or false. Optional. Default is nil. See github.com/jcbhmr/go-platformdirs/api.PlatformDirsABCImpl Appauthor.
- version: Optional. Default is nil. See github.com/jcbhmr/go-platformdirs/api.PlatformDirsABCImpl Version.
- opinion: Optional. Default is true. See github.com/jcbhmr/go-platformdirs/api.PlatformDirsABCImpl Opinion.
- ensureExists: Optional. Default is false. See github.com/jcbhmr/go-platformdirs/api.PlatformDirsABCImpl EnsureExists.
Returns: cache directory tied to the user
func UserCachePath ¶
func UserConfigDir ¶
func UserConfigDir(appname *string, appauthor any, version *string, roaming *bool, ensureExists *bool) string
Params:
- appname: Optional. Default is nil. See github.com/jcbhmr/go-platformdirs/api.PlatformDirsABCImpl Appname.
- appauthor: Must be nil, string, or false. Optional. Default is nil. See github.com/jcbhmr/go-platformdirs/api.PlatformDirsABCImpl Appauthor.
- version: Optional. Default is nil. See github.com/jcbhmr/go-platformdirs/api.PlatformDirsABCImpl Version.
- roaming: Optional. Default is false. See github.com/jcbhmr/go-platformdirs/api.PlatformDirsABCImpl Roaming.
- ensureExists: Optional. Default is false. See github.com/jcbhmr/go-platformdirs/api.PlatformDirsABCImpl EnsureExists.
Returns: config directory tied to the user
func UserConfigPath ¶
func UserDataDir ¶
func UserDataDir(appname *string, appauthor any, version *string, roaming *bool, ensureExists *bool) string
Params:
- appname: Optional. Default is nil. See github.com/jcbhmr/go-platformdirs/api.PlatformDirsABCImpl Appname.
- appauthor: Must be nil, string, or false. Optional. Default is nil. See github.com/jcbhmr/go-platformdirs/api.PlatformDirsABCImpl Appauthor.
- version: Optional. Default is nil. See github.com/jcbhmr/go-platformdirs/api.PlatformDirsABCImpl Version.
- roaming: Optional. Default is false. See github.com/jcbhmr/go-platformdirs/api.PlatformDirsABCImpl Roaming.
- ensureExists: Optional. Default is false. See github.com/jcbhmr/go-platformdirs/api.PlatformDirsABCImpl EnsureExists.
Returns: data directory tied to the user
func UserDataPath ¶
func UserDesktopDir ¶
func UserDesktopDir() string
func UserDesktopPath ¶
func UserDesktopPath() string
func UserDocumentsDir ¶
func UserDocumentsDir() string
func UserDocumentsPath ¶
func UserDocumentsPath() string
func UserDownloadsDir ¶
func UserDownloadsDir() string
func UserDownloadsPath ¶
func UserDownloadsPath() string
func UserLogDir ¶
func UserLogPath ¶
func UserMusicDir ¶
func UserMusicDir() string
func UserMusicPath ¶
func UserMusicPath() string
func UserPicturesDir ¶
func UserPicturesDir() string
func UserPicturesPath ¶
func UserPicturesPath() string
func UserRuntimeDir ¶
func UserRuntimePath ¶
func UserStateDir ¶
func UserStatePath ¶
func UserVideosDir ¶
func UserVideosDir() string
func UserVideosPath ¶
func UserVideosPath() string
Types ¶
Click to show internal directories.
Click to hide internal directories.