configloader

README

ConfigLoader

A simple config loader that watches (and polls) a YAML file on disk, reads and parses it when it changes, and makes the contents available to subscribers and readers.

The loader is generic; you can provide your own type for the loader to use. See the unit test for an example.

Documentation

Index

• type ConfigLoader
  • func NewConfigLoader[Config any](path string) (ret *ConfigLoader[Config], err error)
  • func (b *ConfigLoader[Config]) Close()
  • func (b *ConfigLoader[Config]) Config() (conf *Config)
  • func (b *ConfigLoader[Config]) Load(path string) error
  • func (b *ConfigLoader[Config]) SetConfigPath(path string) error
  • func (b *ConfigLoader[Config]) Subscribe() chan Config

Types

type ConfigLoader

type ConfigLoader[Config any] struct {
	// contains filtered or unexported fields
}

func NewConfigLoader

func NewConfigLoader[Config any](path string) (ret *ConfigLoader[Config], err error)

This might return an error and a valid config loader.

func (*ConfigLoader[Config]) Close

func (b *ConfigLoader[Config]) Close()

func (*ConfigLoader[Config]) Config

func (b *ConfigLoader[Config]) Config() (conf *Config)

func (*ConfigLoader[Config]) Load

func (b *ConfigLoader[Config]) Load(path string) error

func (*ConfigLoader[Config]) SetConfigPath

func (b *ConfigLoader[Config]) SetConfigPath(path string) error

func (*ConfigLoader[Config]) Subscribe

func (b *ConfigLoader[Config]) Subscribe() chan Config