confy

README

confy

A stupid simple configuration store.

Documentation

Index

• func NormKey(key string) string
• type Confy
• type Mem
  • func NewMem() *Mem
  • func (m *Mem) Del(key string) error
  • func (m *Mem) Get(key string, ptr interface{}) error
  • func (m *Mem) Keys() ([]string, error)
  • func (m *Mem) Set(key string, val interface{}) error
• type OS
  • func NewOS(dir, ext string) (*OS, error)
  • func (o *OS) Del(key string) error
  • func (o *OS) Get(key string, ptr interface{}) error
  • func (o *OS) Keys() ([]string, error)
  • func (o *OS) Set(key string, val interface{}) error

Functions

func NormKey

func NormKey(key string) string

NormKey returns the normalised form of a given key.

Confy implementations should use this to achieve consistent behaviour.

Types

type Confy

type Confy interface {
	Get(key string, ptr interface{}) error
	Set(key string, val interface{}) error
	Del(key string) error
	Keys() ([]string, error)
}

A Confy is a stupid simple configuration store.

type Mem

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

func NewMem

func NewMem() *Mem

func (*Mem) Del

func (m *Mem) Del(key string) error

func (*Mem) Get

func (m *Mem) Get(key string, ptr interface{}) error

func (*Mem) Keys

func (m *Mem) Keys() ([]string, error)

func (*Mem) Set

func (m *Mem) Set(key string, val interface{}) error

type OS

type OS struct {
	Directory string
	Extension string
}

OS is a Confy which uses functionality from package os.

func NewOS

func NewOS(dir, ext string) (*OS, error)

NewOS creates a new OS with the given directory and extension.

func (*OS) Del

func (o *OS) Del(key string) error

Del removes the file corresponding to the given key.

func (*OS) Get

func (o *OS) Get(key string, ptr interface{}) error

Get loads JSON data into ptr from the file corresponding to the given key.

func (*OS) Keys

func (o *OS) Keys() ([]string, error)

Keys fetches a list of existing keys using os.ReadDir, filtered by o.Extension and NormKey.

func (*OS) Set

func (o *OS) Set(key string, val interface{}) error

Set writes val in JSON format to the file corresponding to the given key.