config

Documentation

Index

• Constants
• Variables
• func ConfigExists() (bool, error)
• func ConfigPath() (string, error)
• func Dir() (string, error)
• func EnsureDir() (string, error)
• func EnsureKeyringDir() (string, error)
• func GetFavorite(name string) (int, error)
• func KeyringDir() (string, error)
• func ListFavorites() (map[string]int, error)
• func RemoveFavorite(name string) error
• func SetFavorite(name string, stopNumber int) error
• func WriteConfig(cfg File) error
• type File
  • func ReadConfig() (File, error)

Constants

const AppName = "delijn"

Variables

var ErrFavoriteNotFound = errors.New("favorite not found")

ErrFavoriteNotFound is returned when a favorite alias doesn't exist.

Functions

func ConfigExists

func ConfigExists() (bool, error)

func ConfigPath

func ConfigPath() (string, error)

func Dir

func Dir() (string, error)

func EnsureDir

func EnsureDir() (string, error)

func EnsureKeyringDir

func EnsureKeyringDir() (string, error)

func GetFavorite

func GetFavorite(name string) (int, error)

GetFavorite returns the stop number for a favorite alias.

func KeyringDir

func KeyringDir() (string, error)

func ListFavorites

func ListFavorites() (map[string]int, error)

ListFavorites returns all configured favorites.

func RemoveFavorite

func RemoveFavorite(name string) error

RemoveFavorite removes a favorite stop alias.

func SetFavorite

func SetFavorite(name string, stopNumber int) error

SetFavorite sets a favorite stop alias.

func WriteConfig

func WriteConfig(cfg File) error

Types

type File

type File struct {
	Favorites      map[string]int `yaml:"favorites,omitempty"`
	DefaultStop    string         `yaml:"default_stop,omitempty"`
	KeyringBackend string         `yaml:"keyring_backend,omitempty"`
	WatchInterval  int            `yaml:"watch_interval,omitempty"`
	Timezone       string         `yaml:"timezone,omitempty"`
}

func ReadConfig

func ReadConfig() (File, error)