xdgbase

Documentation

Index

• Constants
• func Dir(vendor string, suffix Suffix) (string, error)
• type Suffix

Constants

const (
	// DataSuffix is a single base directory relative to which user-specific data files should be written.
	// This directory is defined by the environment variable $XDG_DATA_HOME.
	DataSuffix = Suffix("DATA_HOME")

	// ConfigSuffix is a single base directory relative to which user-specific configuration files should be written.
	// This directory is defined by the environment variable $XDG_CONFIG_HOME.
	ConfigSuffix = Suffix("CONFIG_HOME")

	// CacheSuffix is a single base directory relative to which user-specific non-essential (cached) data should be written.
	// This directory is defined by the environment variable $XDG_CACHE_HOME.
	CacheSuffix = Suffix("CACHE_HOME")
)

Functions

func Dir

func Dir(vendor string, suffix Suffix) (string, error)

Dir attempts to resolve and respect the XDG Base Directory Specification https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html The resolution to a specific suffix is based on environmental preference

1. VENDOR_SUFFIX (ARK_CACHE_HOME)
2. XDG_SUFFIX (XDG_CACHE_HOME)
3. DEFAULT ($HOME/.cache/ark)

Types

type Suffix

type Suffix string

Suffix should be one of the predefined suffixes in this package

DataSuffix
ConfigSuffix
CacheSuffix