directory

Documentation

Overview

Config loaders to read/write files in directories.

Index

• func GetConfigDir(app string, namespaces ...string) (string, error)
• func Refresh()
• type Directory
  • func OpenDir(base string, sub ...string) (*Directory, error)
  • func OpenHomeDir(app string, namespaces ...string) (*Directory, error)
  • func (hd *Directory) Delete(name string) error
  • func (hd *Directory) List() ([]string, error)
  • func (hd *Directory) Read(name string) ([]byte, error)
  • func (hd *Directory) Write(name string, data []byte) error

Functions

func GetConfigDir

func GetConfigDir(app string, namespaces ...string) (string, error)

Returns the absolute path to a specific folder within the system default configuration directory for the current user.

On Linux systems, this generally means ~/.config/<app>/<namespace>

func Refresh

func Refresh()

Refresh values cached by OpenHomeDir.

Internally, OpenHomeDir caches some of the computed paths. Refresh() will cause those paths to be re-computed.

Don't bother calling Refresh() unless your project mingles with the HOME environment variable, or variables like XDG_CONFIG_HOME.

Types

type Directory

type Directory struct {
	// contains filtered or unexported fields
}

func OpenDir

func OpenDir(base string, sub ...string) (*Directory, error)

OpenDir returns a Loader capable of loading and creating config files in the specified directory.

func OpenHomeDir

func OpenHomeDir(app string, namespaces ...string) (*Directory, error)

OpenHomeDir returns a Loader capable of loading and creating config files in the system default configuration directory for the current user.

On Linux systems, this generally means ~/.config/<app>/<namespace>/.

func (*Directory) Delete

func (hd *Directory) Delete(name string) error

func (*Directory) List

func (hd *Directory) List() ([]string, error)

func (*Directory) Read

func (hd *Directory) Read(name string) ([]byte, error)

func (*Directory) Write

func (hd *Directory) Write(name string, data []byte) error