config

Documentation

Index

• type Config
  • func Setup(dir string) (Config, error)
  • func SetupDefault(dir string) (Config, error)
• type Search

Types

type Config

type Config interface {
	ReadEntries() (scoring.Entries, error)
	WriteEntries(scoring.Entries) error

	ReadSearch() Search
	WriteSearch(string, int) error

	ReadPins() (map[string]string, error)
	FindPin(string) (string, bool)
	WritePin(string, string) error
	RemovePin(string) error
}

Config represents the config directory and all the miscellaneous configuration files we can have in there.

func Setup

func Setup(dir string) (Config, error)

Setup setups the config folder from a directory path.

If the directories don't already exists, they are created and if the score file is present, it is loaded.

func SetupDefault

func SetupDefault(dir string) (Config, error)

SetupDefault setups the config folder from a directory path.

If the directory path is an empty string, the path is automatically guessed.

type Search

type Search struct {
	Term  string
	Index int
}

Search represents a search term used for advancing through the entries of the same term.