gconfig

package module

Go to main page

Versions in this module

v1

v1.4.0

Jun 21, 2022

Changes in this version

+ const SourceTypeDirectory

+ const SourceTypeObservableDirectory

+ var DefaultFileFormat = genv.String("GCONFIG_DEFAULT_FILE_FORMAT", DecoderFormatYAML)

+ var DefaultRemoteFormat = genv.String("GCONFIG_DEFAULT_REMOTE_FORMAT", DecoderFormatJSON)

type Source

+ func NewSourceDir(path, format string, recursive bool, fs afero.Fs, factory *DecoderFactory) (Source, error)

type SourceStrategy

+ func NewSourceStrategyDir(fs afero.Fs, factory *DecoderFactory) (SourceStrategy, error)

v1.3.0

May 3, 2022

Changes in this version

type Partial

+ func (p Partial) Clone() Partial

v1.2.2

May 2, 2022

v1.2.1

May 2, 2022

v1.2.0

May 1, 2022

Changes in this version

type Config

+ Partial func(path string, def ...Partial) (Partial, error)

+ type Manager interface

+ type Observable interface

+ AddObserver func(path string, callback Observer) error

+ HasObserver func(path string) bool

+ RemoveObserver func(path string)

+ type Partial map[interface{}]interface

+ func (p *Partial) Bool(path string, def ...bool) (bool, error)

+ func (p *Partial) Float(path string, def ...float64) (float64, error)

+ func (p *Partial) Get(path string, def ...interface{}) (interface{}, error)

+ func (p *Partial) Has(path string) bool

+ func (p *Partial) Int(path string, def ...int) (int, error)

+ func (p *Partial) List(path string, def ...[]interface{}) ([]interface{}, error)

+ func (p *Partial) Partial(path string, def ...Partial) (Partial, error)

+ func (p *Partial) String(path string, def ...string) (string, error)

+ type Sourced interface

+ AddSource func(id string, priority int, src Source) error

+ HasSource func(id string) bool

+ RemoveAllSources func() error

+ RemoveSource func(id string) error

+ Source func(id string) (Source, error)

+ SourcePriority func(id string, priority int) error

v1.1.0

Apr 28, 2022

v1.0.0

Apr 27, 2022

Changes in this version

+ const DecoderFormatJSON

+ const DecoderFormatUnknown

+ const DecoderFormatYAML

+ const Env

+ const EnvLoaderSourceFormat

+ const EnvLoaderSourceID

+ const EnvLoaderSourceListPath

+ const EnvLoaderSourcePath

+ const EnvPathSeparator

+ const SourceTypeEnv

+ const SourceTypeFile

+ const SourceTypeObservableFile

+ const SourceTypeObservableRemote

+ const SourceTypeRemote

+ const SourceTypeUnknown

+ var ErrConversion = errors.New("invalid type conversion")

+ var ErrDuplicateSource = fmt.Errorf("SourcedConfig source already registered")

+ var ErrInvalidDecoderFormat = fmt.Errorf("invalid SourcedConfig decoder format")

+ var ErrInvalidSourceConfig = fmt.Errorf("invalid SourcedConfig source SourcedConfig")

+ var ErrInvalidSourceType = fmt.Errorf("invalid SourcedConfig source type")

+ var ErrNilPointer = errors.New("invalid nil pointer")

+ var ErrPathNotFound = fmt.Errorf("SourcedConfig path not found")

+ var ErrRemoteConfigPathNotFound = fmt.Errorf("path of SourcedConfig not found")

+ var ErrRemoteTimestampPathNotFound = fmt.Errorf("path of timestamp not found")

+ var ErrSourceNotFound = fmt.Errorf("SourcedConfig source not found")

+ var LoaderSourceFormat = genv.String(EnvLoaderSourceFormat, DecoderFormatYAML)

+ var LoaderSourceID = genv.String(EnvLoaderSourceID, "main")

+ var LoaderSourceListPath = genv.String(EnvLoaderSourceListPath, "configs")

+ var LoaderSourcePath = genv.String(EnvLoaderSourcePath, "config/config.yaml")

+ var PathSeparator = genv.String(EnvPathSeparator, ".")

+ type Config interface

+ Bool func(path string, def ...bool) (bool, error)

+ Config func(path string, def ...Config) (Config, error)

+ Float func(path string, def ...float64) (float64, error)

+ Get func(path string, def ...interface{}) (interface{}, error)

+ Has func(path string) bool

+ Int func(path string, def ...int) (int, error)

+ List func(path string, def ...[]interface{}) ([]interface{}, error)

+ String func(path string, def ...string) (string, error)

+ type Decoder interface

+ Decode func() (Config, error)

+ func NewDecoderJSON(reader io.Reader) (Decoder, error)

+ func NewDecoderYAML(reader io.Reader) (Decoder, error)

+ type DecoderFactory []DecoderStrategy

+ func (f *DecoderFactory) Register(strategy DecoderStrategy) error

+ func (f DecoderFactory) Create(format string, args ...interface{}) (Decoder, error)

+ type DecoderStrategy interface

+ Accept func(format string) bool

+ Create func(args ...interface{}) (Decoder, error)

+ type DecoderStrategyJSON struct

+ func (DecoderStrategyJSON) Accept(format string) bool

+ func (DecoderStrategyJSON) Create(args ...interface{}) (Decoder, error)

+ type DecoderStrategyYAML struct

+ func (DecoderStrategyYAML) Accept(format string) bool

+ func (DecoderStrategyYAML) Create(args ...interface{}) (Decoder, error)

+ type HTTPClient interface

+ Do func(req *http.Request) (*http.Response, error)

+ type Loader struct

+ func NewLoader(cfg *SourcedConfig, factory *SourceFactory) (*Loader, error)

+ func (l Loader) Load() error

+ type Observer func(interface{}, interface{})

+ type Source interface

+ Get func(path string, def ...interface{}) (interface{}, error)

+ Has func(path string) bool

+ func NewSourceEnv(mappings map[string]string) (Source, error)

+ func NewSourceFile(path, format string, fs afero.Fs, factory *DecoderFactory) (Source, error)

+ func NewSourceRemote(client HTTPClient, uri, format string, factory *DecoderFactory, ...) (Source, error)

+ type SourceFactory []SourceStrategy

+ func (f *SourceFactory) Register(strategy SourceStrategy) error

+ func (f SourceFactory) Create(stype string, args ...interface{}) (Source, error)

+ func (f SourceFactory) CreateFromConfig(cfg Config) (Source, error)

+ type SourceObservable interface

+ Reload func() (bool, error)

+ func NewSourceObservableFile(path, format string, fs afero.Fs, factory *DecoderFactory) (SourceObservable, error)

+ func NewSourceObservableRemote(client HTTPClient, uri, format string, factory *DecoderFactory, ...) (SourceObservable, error)

+ type SourceStrategy interface

+ Accept func(stype string) bool

+ AcceptFromConfig func(cfg Config) bool

+ Create func(args ...interface{}) (Source, error)

+ CreateFromConfig func(cfg Config) (Source, error)

+ func NewSourceStrategyFile(fs afero.Fs, factory *DecoderFactory) (SourceStrategy, error)

+ func NewSourceStrategyObservableFile(fs afero.Fs, factory *DecoderFactory) (SourceStrategy, error)

+ func NewSourceStrategyObservableRemote(decoderFactory *DecoderFactory) (SourceStrategy, error)

+ func NewSourceStrategyRemote(decoderFactory *DecoderFactory) (SourceStrategy, error)

+ type SourceStrategyEnv struct

+ func (SourceStrategyEnv) Accept(stype string) bool

+ func (s SourceStrategyEnv) AcceptFromConfig(cfg Config) bool

+ func (s SourceStrategyEnv) Create(args ...interface{}) (Source, error)

+ func (s SourceStrategyEnv) CreateFromConfig(cfg Config) (Source, error)

+ type SourcedConfig struct

+ func NewConfig(period time.Duration) *SourcedConfig

+ func (c *SourcedConfig) AddObserver(path string, callback Observer) error

+ func (c *SourcedConfig) AddSource(id string, priority int, src Source) error

+ func (c *SourcedConfig) Bool(path string, def ...bool) (bool, error)

+ func (c *SourcedConfig) Close() error

+ func (c *SourcedConfig) Config(path string, def ...Config) (Config, error)

+ func (c *SourcedConfig) Float(path string, def ...float64) (float64, error)

+ func (c *SourcedConfig) Get(path string, def ...interface{}) (interface{}, error)

+ func (c *SourcedConfig) Has(path string) bool

+ func (c *SourcedConfig) HasObserver(path string) bool

+ func (c *SourcedConfig) HasSource(id string) bool

+ func (c *SourcedConfig) Int(path string, def ...int) (int, error)

+ func (c *SourcedConfig) List(path string, def ...[]interface{}) ([]interface{}, error)

+ func (c *SourcedConfig) RemoveAllSources() error

+ func (c *SourcedConfig) RemoveObserver(path string)

+ func (c *SourcedConfig) RemoveSource(id string) error

+ func (c *SourcedConfig) Source(id string) (Source, error)

+ func (c *SourcedConfig) SourcePriority(id string, priority int) error

+ func (c *SourcedConfig) String(path string, def ...string) (string, error)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL