platformdirs

package module
v0.0.0-...-c540883 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 23, 2024 License: MIT Imports: 7 Imported by: 0

README

go-platformdirs

📂 Python's platformdirs package for Go

Documentation

Index

Constants

This section is empty.

Variables

View Source
var Version = version.Version
View Source
var VersionInfo = version.VersionTuple

Functions

func SiteCacheDir

func SiteCacheDir(appname *string, appauthor any, version *string, opinion *bool, ensureExists *bool) string

func SiteCachePath

func SiteCachePath(appname *string, appauthor any, version *string, opinion *bool, ensureExists *bool) string

func SiteConfigDir

func SiteConfigDir(appname *string, appauthor any, version *string, multipath *bool, ensureExists *bool) string

Params:

Returns: config directory shared by users

func SiteConfigPath

func SiteConfigPath(appname *string, appauthor any, version *string, multipath *bool, ensureExists *bool) string

func SiteDataDir

func SiteDataDir(appname *string, appauthor any, version *string, multipath *bool, ensureExists *bool) string

Params:

Returns: configuration directory shared by users

func SiteDataPath

func SiteDataPath(appname *string, appauthor any, version *string, multipath *bool, ensureExists *bool) string

func SiteRuntimeDir

func SiteRuntimeDir(appname *string, appauthor any, version *string, opinion *bool, ensureExists *bool) string

func SiteRuntimePath

func SiteRuntimePath(appname *string, appauthor any, version *string, opinion *bool, ensureExists *bool) string

func UserCacheDir

func UserCacheDir(appname *string, appauthor any, version *string, opinion *bool, ensureExists *bool) string

Params:

Returns: cache directory tied to the user

func UserCachePath

func UserCachePath(appname *string, appauthor any, version *string, opinion *bool, ensureExists *bool) string

func UserConfigDir

func UserConfigDir(appname *string, appauthor any, version *string, roaming *bool, ensureExists *bool) string

Params:

Returns: config directory tied to the user

func UserConfigPath

func UserConfigPath(appname *string, appauthor any, version *string, roaming *bool, ensureExists *bool) string

func UserDataDir

func UserDataDir(appname *string, appauthor any, version *string, roaming *bool, ensureExists *bool) string

Params:

Returns: data directory tied to the user

func UserDataPath

func UserDataPath(appname *string, appauthor any, version *string, roaming *bool, ensureExists *bool) string

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 UserLogDir(appname *string, appauthor any, version *string, opinion *bool, ensureExists *bool) string

func UserLogPath

func UserLogPath(appname *string, appauthor any, version *string, opinion *bool, ensureExists *bool) string

func UserMusicDir

func UserMusicDir() string

func UserMusicPath

func UserMusicPath() string

func UserPicturesDir

func UserPicturesDir() string

func UserPicturesPath

func UserPicturesPath() string

func UserRuntimeDir

func UserRuntimeDir(appname *string, appauthor any, version *string, opinion *bool, ensureExists *bool) string

func UserRuntimePath

func UserRuntimePath(appname *string, appauthor any, version *string, opinion *bool, ensureExists *bool) string

func UserStateDir

func UserStateDir(appname *string, appauthor any, version *string, roaming *bool, ensureExists *bool) string

func UserStatePath

func UserStatePath(appname *string, appauthor any, version *string, roaming *bool, ensureExists *bool) string

func UserVideosDir

func UserVideosDir() string

func UserVideosPath

func UserVideosPath() string

Types

type AppDirs

type AppDirs = PlatformDirs

Backwards compatibility with appdirs

func NewAppDirs

func NewAppDirs(appname *string, appauthor any, version *string, roaming *bool, multipath *bool, opinion *bool, ensureExists *bool) AppDirs

Backwards compatibility with appdirs

type PlatformDirs

type PlatformDirs = unix.Unix

Currently active platform

func New

func New(appname *string, appauthor any, version *string, roaming *bool, multipath *bool, opinion *bool, ensureExists *bool) PlatformDirs

Currently active platform

Directories

Path Synopsis
cmd
platformdirs command
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL