settings

Documentation

Index

• type ApplicationSettings
  • func (applicationSettings ApplicationSettings) FromFile(obj interface{}, fileName string) (result interface{}, err error)
  • func (applicationSettings ApplicationSettings) FromReader(obj interface{}, reader io.Reader) (result interface{}, err error)
  • func (applicationSettings ApplicationSettings) FromString(obj interface{}, data string) (result interface{}, err error)
  • func (applicationSettings ApplicationSettings) GetSettings(objType reflect.Type, watcher Watcher) (result *Configuration, err error)
• type Configuration
  • func (cfg Configuration) Config() interface{}
  • func (cfg *Configuration) Set(config interface{})
  • func (cfg *Configuration) Subscribe() chan *Configuration
• type EventConfiguration
  • func CreateEventConfiguration() *EventConfiguration
• type Watcher
• type WatcherSettingsCreator
• type WithInit

Types

type ApplicationSettings

type ApplicationSettings struct {
}

ApplicationSettings - provide loading and updating application settings

func (ApplicationSettings) FromFile

func (applicationSettings ApplicationSettings) FromFile(obj interface{}, fileName string) (result interface{}, err error)

FromFile - Load settings from file

func (ApplicationSettings) FromReader

func (applicationSettings ApplicationSettings) FromReader(obj interface{}, reader io.Reader) (result interface{}, err error)

FromReader - Load settings from reader

func (ApplicationSettings) FromString

func (applicationSettings ApplicationSettings) FromString(obj interface{}, data string) (result interface{}, err error)

FromString - Load settings from string/

func (ApplicationSettings) GetSettings

func (applicationSettings ApplicationSettings) GetSettings(objType reflect.Type, watcher Watcher) (result *Configuration, err error)

GetSettings - Get settings with monitoring of changes

type Configuration

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

Configuration - provide access to latest settings

func (Configuration) Config

func (cfg Configuration) Config() interface{}

Config - latest settings

func (*Configuration) Set

func (cfg *Configuration) Set(config interface{})

Set - set settings

func (*Configuration) Subscribe

func (cfg *Configuration) Subscribe() chan *Configuration

Subscribe - subscribe to event when config changed

type EventConfiguration

type EventConfiguration struct {
	Channel chan *Configuration
}

func CreateEventConfiguration

func CreateEventConfiguration() *EventConfiguration

type Watcher

type Watcher interface {
	Setup(cfg *Configuration, creator WatcherSettingsCreator) error
}

Watcher - interface for watching settings from source and update it in configuration

type WatcherSettingsCreator

type WatcherSettingsCreator func(data string) (result interface{}, err error)

WatcherSettingsCreator - create settings from the string

type WithInit

type WithInit interface {
	Init() error
}

WithInit - Interface for initiate settings after it loaded