xdg

package
v0.32.48 Latest Latest
Warning

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

 Go to latest Published: Feb 6, 2025 License: Apache-2.0, MIT Imports: 4 Imported by: 0

README

XDG

The xdg package is an adaptation of https://github.com/adrg/xdg It uses the Unix directory locations on MacOS

Documentation

Index

Examples

Constants

This section is empty.

Variables

View Source 
var (
	// Home contains the path of the user's home directory.
	Home string

	// DataHome defines the base directory relative to which user-specific
	// data files should be stored. This directory is defined by the
	// $XDG_DATA_HOME environment variable. If the variable is not set,
	// a default equal to $HOME/.local/share should be used.
	DataHome string

	// DataDirs defines the preference-ordered set of base directories to
	// search for data files in addition to the DataHome base directory.
	// This set of directories is defined by the $XDG_DATA_DIRS environment
	// variable. If the variable is not set, the default directories
	// to be used are /usr/local/share and /usr/share, in that order. The
	// DataHome directory is considered more important than any of the
	// directories defined by DataDirs. Therefore, user data files should be
	// written relative to the DataHome directory, if possible.
	DataDirs []string

	// ConfigHome defines the base directory relative to which user-specific
	// configuration files should be written. This directory is defined by
	// the $XDG_CONFIG_HOME environment variable. If the variable is
	// not set, a default equal to $HOME/.config should be used.
	ConfigHome string

	// ConfigDirs defines the preference-ordered set of base directories to
	// search for configuration files in addition to the ConfigHome base
	// directory. This set of directories is defined by the $XDG_CONFIG_DIRS
	// environment variable. If the variable is not set, a default equal
	// to /etc/xdg should be used. The ConfigHome directory is considered
	// more important than any of the directories defined by ConfigDirs.
	// Therefore, user config files should be written relative to the
	// ConfigHome directory, if possible.
	ConfigDirs []string

	// StateHome defines the base directory relative to which user-specific
	// state files should be stored. This directory is defined by the
	// $XDG_STATE_HOME environment variable. If the variable is not set,
	// a default equal to ~/.local/state should be used.
	StateHome string

	// CacheHome defines the base directory relative to which user-specific
	// non-essential (cached) data should be written. This directory is
	// defined by the $XDG_CACHE_HOME environment variable. If the variable
	// is not set, a default equal to $HOME/.cache should be used.
	CacheHome string

	// RuntimeDir defines the base directory relative to which user-specific
	// non-essential runtime files and other file objects (such as sockets,
	// named pipes, etc.) should be stored. This directory is defined by the
	// $XDG_RUNTIME_DIR environment variable. If the variable is not set,
	// applications should fall back to a replacement directory with similar
	// capabilities. Applications should use this directory for communication
	// and synchronization purposes and should not place larger files in it,
	// since it might reside in runtime memory and cannot necessarily be
	// swapped out to disk.
	RuntimeDir string

	// UserDirs defines the locations of well known user directories.
	UserDirs UserDirectories

	// FontDirs defines the common locations where font files are stored.
	FontDirs []string

	// ApplicationDirs defines the common locations of applications.
	ApplicationDirs []string
)

Functions

func CacheFile 

func CacheFile(relPath string) (string, error)

CacheFile returns a suitable location for the specified cache file. The relPath parameter must contain the name of the cache file, and optionally, a set of parent directories (e.g. appname/app.cache). If the specified directories do not exist, they will be created relative to the base cache directory. On failure, an error containing the attempted paths is returned.

Example 
package main

import (
	"fmt"

	"github.com/aserto-dev/topaz/internal/pkg/xdg"
)

func main() {
	cacheFilePath, err := xdg.CacheFile("appname/app.cache")
	if err != nil {
		// Treat error.
	}

	fmt.Println("Save cache file at:", cacheFilePath)
}

func ConfigFile 

func ConfigFile(relPath string) (string, error)

ConfigFile returns a suitable location for the specified config file. The relPath parameter must contain the name of the config file, and optionally, a set of parent directories (e.g. appname/app.yaml). If the specified directories do not exist, they will be created relative to the base config directory. On failure, an error containing the attempted paths is returned.

Example 
package main

import (
	"fmt"

	"github.com/aserto-dev/topaz/internal/pkg/xdg"
)

func main() {
	configFilePath, err := xdg.ConfigFile("appname/app.yaml")
	if err != nil {
		// Treat error.
	}

	fmt.Println("Save config file at:", configFilePath)
}

func DataFile 

func DataFile(relPath string) (string, error)

DataFile returns a suitable location for the specified data file. The relPath parameter must contain the name of the data file, and optionally, a set of parent directories (e.g. appname/app.data). If the specified directories do not exist, they will be created relative to the base data directory. On failure, an error containing the attempted paths is returned.

Example 
package main

import (
	"fmt"

	"github.com/aserto-dev/topaz/internal/pkg/xdg"
)

func main() {
	dataFilePath, err := xdg.DataFile("appname/app.data")
	if err != nil {
		// Treat error.
	}

	fmt.Println("Save data file at:", dataFilePath)
}

func Reload 

func Reload()

Reload refreshes base and user directories by reading the environment. Defaults are applied for XDG variables which are empty or not present in the environment.

func RuntimeFile 

func RuntimeFile(relPath string) (string, error)

RuntimeFile returns a suitable location for the specified runtime file. The relPath parameter must contain the name of the runtime file, and optionally, a set of parent directories (e.g. appname/app.pid). If the specified directories do not exist, they will be created relative to the base runtime directory. On failure, an error containing the attempted paths is returned.

Example 
package main

import (
	"fmt"

	"github.com/aserto-dev/topaz/internal/pkg/xdg"
)

func main() {
	runtimeFilePath, err := xdg.RuntimeFile("appname/app.pid")
	if err != nil {
		// Treat error.
	}

	fmt.Println("Save runtime file at:", runtimeFilePath)
}

func SearchCacheFile 

func SearchCacheFile(relPath string) (string, error)

SearchCacheFile searches for the specified file in the cache search path. The relPath parameter must contain the name of the cache file, and optionally, a set of parent directories (e.g. appname/app.cache). If the file cannot be found, an error specifying the searched path is returned.

Example 
package main

import (
	"fmt"

	"github.com/aserto-dev/topaz/internal/pkg/xdg"
)

func main() {
	cacheFilePath, err := xdg.SearchCacheFile("appname/app.cache")
	if err != nil {
		// The cache file could not be found.
	}

	fmt.Println("The cache file was found at:", cacheFilePath)
}

func SearchConfigFile 

func SearchConfigFile(relPath string) (string, error)

SearchConfigFile searches for the specified file in config search paths. The relPath parameter must contain the name of the config file, and optionally, a set of parent directories (e.g. appname/app.yaml). If the file cannot be found, an error specifying the searched paths is returned.

Example 
package main

import (
	"fmt"

	"github.com/aserto-dev/topaz/internal/pkg/xdg"
)

func main() {
	configFilePath, err := xdg.SearchConfigFile("appname/app.yaml")
	if err != nil {
		// The config file could not be found.
	}

	fmt.Println("The config file was found at:", configFilePath)
}

func SearchDataFile 

func SearchDataFile(relPath string) (string, error)

SearchDataFile searches for specified file in the data search paths. The relPath parameter must contain the name of the data file, and optionally, a set of parent directories (e.g. appname/app.data). If the file cannot be found, an error specifying the searched paths is returned.

Example 
package main

import (
	"fmt"

	"github.com/aserto-dev/topaz/internal/pkg/xdg"
)

func main() {
	dataFilePath, err := xdg.SearchDataFile("appname/app.data")
	if err != nil {
		// The data file could not be found.
	}

	fmt.Println("The data file was found at:", dataFilePath)
}

func SearchRuntimeFile 

func SearchRuntimeFile(relPath string) (string, error)

SearchRuntimeFile searches for the specified file in the runtime search path. The relPath parameter must contain the name of the runtime file, and optionally, a set of parent directories (e.g. appname/app.pid). If the file cannot be found, an error specifying the searched path is returned.

Example 
package main

import (
	"fmt"

	"github.com/aserto-dev/topaz/internal/pkg/xdg"
)

func main() {
	runtimeFilePath, err := xdg.SearchRuntimeFile("appname/app.pid")
	if err != nil {
		// The runtime file could not be found.
	}

	fmt.Println("The runtime file was found at:", runtimeFilePath)
}

func SearchStateFile 

func SearchStateFile(relPath string) (string, error)

SearchStateFile searches for the specified file in the state search path. The relPath parameter must contain the name of the state file, and optionally, a set of parent directories (e.g. appname/app.state). If the file cannot be found, an error specifying the searched path is returned.

Example 
package main

import (
	"fmt"

	"github.com/aserto-dev/topaz/internal/pkg/xdg"
)

func main() {
	stateFilePath, err := xdg.SearchStateFile("appname/app.state")
	if err != nil {
		// The state file could not be found.
	}

	fmt.Println("The state file was found at:", stateFilePath)
}

func StateFile 

func StateFile(relPath string) (string, error)

StateFile returns a suitable location for the specified state file. State files are usually volatile data files, not suitable to be stored relative to the $XDG_DATA_HOME directory. The relPath parameter must contain the name of the state file, and optionally, a set of parent directories (e.g. appname/app.state). If the specified directories do not exist, they will be created relative to the base state directory. On failure, an error containing the attempted paths is returned.

Example 
package main

import (
	"fmt"

	"github.com/aserto-dev/topaz/internal/pkg/xdg"
)

func main() {
	stateFilePath, err := xdg.DataFile("appname/app.state")
	if err != nil {
		// Treat error.
	}

	fmt.Println("Save state file at:", stateFilePath)
}

Types

type UserDirectories 

type UserDirectories struct {
	// Desktop defines the location of the user's desktop directory.
	Desktop string

	// Download defines a suitable location for user downloaded files.
	Download string

	// Documents defines a suitable location for user document files.
	Documents string

	// Music defines a suitable location for user audio files.
	Music string

	// Pictures defines a suitable location for user image files.
	Pictures string

	// VideosDir defines a suitable location for user video files.
	Videos string

	// Templates defines a suitable location for user template files.
	Templates string

	// PublicShare defines a suitable location for user shared files.
	PublicShare string
}

UserDirectories defines the locations of well known user directories.

Source Files

View all Source files

Directories

Path Synopsis
internal
pathutil

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.