dir

Documentation

Index

• Constants
• func Cache(ctx context.Context) string
• func Config(ctx context.Context) string
• func WithCacheDir(ctx context.Context, p string) context.Context
• func WithConfigDir(ctx context.Context, p string) context.Context

Constants

const (
	// ConfigDirEnvName is the name of the environment variable that can be used
	// to override the config directory.
	ConfigDirEnvName = "KN_CONFIG_DIR"

	// CacheDirEnvName is the name of the environment variable that can be used
	// to override the cache directory.
	CacheDirEnvName = "KN_CACHE_DIR"
)

Functions

func Cache

func Cache(ctx context.Context) string

Cache returns the path to the cache directory. It will be created if it does not exist.

func Config

func Config(ctx context.Context) string

Config returns the path to the config directory. It will be created if it does not exist.

func WithCacheDir

func WithCacheDir(ctx context.Context, p string) context.Context

WithCacheDir returns a new context with the given cache directory configured. It should be used for testing only.

func WithConfigDir

func WithConfigDir(ctx context.Context, p string) context.Context

WithConfigDir returns a new context with the given config directory configured. It should be used for testing only.