xdg

package

v0.0.0-...-3525705 Latest Latest Go to latest Published: Dec 31, 2025 License: MIT Imports: 12 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

www.github.com/friedenberg/dodder

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
type DefaultEnvVar
- func (defaultEnvVar DefaultEnvVar) MakeBaseEnvVar(actual string) env_vars.DirectoryLayoutBaseEnvVar
type Dotenv
- func (dotenv Dotenv) ReadFrom(reader io.Reader) (n int64, err error)
- func (dotenv Dotenv) WriteTo(writer io.Writer) (n int64, err error)
type InitArgs
- func (initArgs *InitArgs) Initialize(utilityName string) (err error)
type XDG

Constants ¶

View Source

const EnvXDGUtilityNameOverride = "DODDER_XDG_UTILITY_OVERRIDE"

Variables ¶

View Source

var (
	DefaultHome = DefaultEnvVar{
		Name:                 "HOME",
		DefaultValueTemplate: "$HOME",
		// contains filtered or unexported fields
	}

	DefaultData = DefaultEnvVar{
		Name:                 "XDG_DATA_HOME",
		DefaultValueTemplate: "$HOME/.local/share",
		// contains filtered or unexported fields
	}

	DefaultConfig = DefaultEnvVar{
		Name:                 "XDG_CONFIG_HOME",
		DefaultValueTemplate: "$HOME/.config",
		// contains filtered or unexported fields
	}

	DefaultState = DefaultEnvVar{
		Name:                 "XDG_STATE_HOME",
		DefaultValueTemplate: "$HOME/.local/state",
		// contains filtered or unexported fields
	}

	DefaultCache = DefaultEnvVar{
		Name:                 "XDG_CACHE_HOME",
		DefaultValueTemplate: "$HOME/.cache",
		// contains filtered or unexported fields
	}

	DefaultRuntime = DefaultEnvVar{
		Name:                 "XDG_RUNTIME_HOME",
		DefaultValueTemplate: "$HOME/.local/runtime",
		// contains filtered or unexported fields
	}
)

Functions ¶

This section is empty.

Types ¶

type DefaultEnvVar ¶

type DefaultEnvVar struct {
	Name                 string
	DefaultValueTemplate string
	// contains filtered or unexported fields
}

func (DefaultEnvVar) MakeBaseEnvVar ¶

func (defaultEnvVar DefaultEnvVar) MakeBaseEnvVar(
	actual string,
) env_vars.DirectoryLayoutBaseEnvVar

type Dotenv ¶

type Dotenv struct {
	*XDG
}

TODO replace with env_vars.BufferedCoderDotenv

func (Dotenv) ReadFrom ¶

func (dotenv Dotenv) ReadFrom(reader io.Reader) (n int64, err error)

func (Dotenv) WriteTo ¶

func (dotenv Dotenv) WriteTo(writer io.Writer) (n int64, err error)

type InitArgs ¶

type InitArgs struct {
	Home        string
	Cwd         string
	UtilityName string
	ExecPath    string
	Pid         int
}

func (*InitArgs) Initialize ¶

func (initArgs *InitArgs) Initialize(utilityName string) (err error)

type XDG ¶

type XDG struct {
	Home env_vars.DirectoryLayoutBaseEnvVar
	Cwd  env_vars.DirectoryLayoutBaseEnvVar

	UtilityName string

	Data    env_vars.DirectoryLayoutBaseEnvVar
	Config  env_vars.DirectoryLayoutBaseEnvVar
	State   env_vars.DirectoryLayoutBaseEnvVar
	Cache   env_vars.DirectoryLayoutBaseEnvVar
	Runtime env_vars.DirectoryLayoutBaseEnvVar
	// contains filtered or unexported fields
}

func (XDG) AddToEnvVars ¶

func (xdg XDG) AddToEnvVars(envVars interfaces.EnvVars)

func (XDG) CloneWithUtilityName ¶

func (xdg XDG) CloneWithUtilityName(
	name string,
) XDG

func (XDG) CloneWithoutOverride ¶

func (xdg XDG) CloneWithoutOverride() XDG

func (XDG) GetDirCache ¶

func (xdg XDG) GetDirCache() interfaces.DirectoryLayoutBaseEnvVar

func (XDG) GetDirConfig ¶

func (xdg XDG) GetDirConfig() interfaces.DirectoryLayoutBaseEnvVar

func (XDG) GetDirCwd ¶

func (xdg XDG) GetDirCwd() interfaces.DirectoryLayoutBaseEnvVar

func (XDG) GetDirData ¶

func (xdg XDG) GetDirData() interfaces.DirectoryLayoutBaseEnvVar

func (XDG) GetDirHome ¶

func (xdg XDG) GetDirHome() interfaces.DirectoryLayoutBaseEnvVar

func (XDG) GetDirRuntime ¶

func (xdg XDG) GetDirRuntime() interfaces.DirectoryLayoutBaseEnvVar

func (XDG) GetDirState ¶

func (xdg XDG) GetDirState() interfaces.DirectoryLayoutBaseEnvVar

func (XDG) GetLocationType ¶

func (xdg XDG) GetLocationType() blob_store_id.LocationType

func (XDG) GetXDGEnvVars ¶

func (xdg XDG) GetXDGEnvVars() []env_vars.DirectoryLayoutBaseEnvVar

func (XDG) GetXDGPaths ¶

func (xdg XDG) GetXDGPaths() []string

func (*XDG) InitializeOverridden ¶

func (xdg *XDG) InitializeOverridden(
	initArgs InitArgs,
	overridePath string,
) (err error)

func (*XDG) InitializeOverriddenIfNecessary ¶

func (xdg *XDG) InitializeOverriddenIfNecessary(
	initArgs InitArgs,
) (err error)

func (*XDG) InitializeStandardFromEnv ¶

func (xdg *XDG) InitializeStandardFromEnv(
	initArgs InitArgs,
) (err error)

Source Files ¶

defaults.go
dotenv.go
init_args.go
init_elements.go
main.go

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