settings

Documentation

Index

• func GetRuntimeSetting(setting string) (interface{}, error)
• func InitRuntimeSettings() error
• func RuntimeSettings() map[string]RuntimeSetting
• func SetRuntimeSetting(setting string, value interface{}) error
• type RuntimeSetting
• type RuntimeSettingResponse
• type SettingNotFoundError
  • func (e *SettingNotFoundError) Error() string

Functions

func GetRuntimeSetting

func GetRuntimeSetting(setting string) (interface{}, error)

GetRuntimeSetting returns the value of a runtime configurable setting

func InitRuntimeSettings

func InitRuntimeSettings() error

InitRuntimeSettings builds the map of runtime settings configurable at runtime.

func RuntimeSettings

func RuntimeSettings() map[string]RuntimeSetting

RuntimeSettings returns all runtime configurable settings

func SetRuntimeSetting

func SetRuntimeSetting(setting string, value interface{}) error

SetRuntimeSetting changes the value of a runtime configurable setting

Types

type RuntimeSetting

type RuntimeSetting interface {
	Get() (interface{}, error)
	Set(v interface{}) error
	Name() string
	Description() string
	Hidden() bool
}

RuntimeSetting represents a setting that can be changed and read at runtime.

type RuntimeSettingResponse

type RuntimeSettingResponse struct {
	Description string
	Hidden      bool
}

RuntimeSettingResponse is used to communicate settings config

type SettingNotFoundError

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

SettingNotFoundError is used to warn about non existing/not registered runtime setting

func (*SettingNotFoundError) Error

func (e *SettingNotFoundError) Error() string