yachg

Documentation

Overview

Package yachg provides observable config values and tools to watch config files for changes while a program is running.

Index

• func Reload(cfg any, log ReloadLog, files ...string) error
• type Obs
  • func NewObs[T comparable](init T, defaultTag interface{}, defaultChg change.Flags, os ...change.Observer) Obs[T]
  • func (o *Obs[T]) Flag(name, usage string, set *flag.FlagSet)
  • func (o *Obs[T]) Get() T
  • func (o *Obs[T]) MarshalJSON() ([]byte, error)
  • func (o *Obs[T]) MergeDaQ(by *daq.Merge, add any) error
  • func (o *Obs[T]) Set(v T, chg change.Flags) change.Flags
  • func (o *Obs[T]) UnmarshalJSON(data []byte) error
• type On
  • func NewOn[T comparable](init T, hook change.HookFunc[T]) On[T]
  • func (o *On[T]) Flag(name, usage string, set *flag.FlagSet)
  • func (cv *On[T]) Get() T
  • func (o *On[T]) MarshalJSON() ([]byte, error)
  • func (o *On[T]) MergeDaQ(by *daq.Merge, add any) error
  • func (cv *On[T]) Set(v T, chg change.Flags) change.Flags
  • func (o *On[T]) UnmarshalJSON(data []byte) error
• type ReloadLog
  • func StdLog(l *log.Logger) ReloadLog

Examples

• Obs (Json)
• On (Json)

Functions

func Reload

func Reload(cfg any, log ReloadLog, files ...string) error

Types

type Obs

type Obs[T comparable] struct {
	change.Obs[T]
	// contains filtered or unexported fields
}

Example (Json)

var cfg struct {
	Log Obs[bool]
}
cfg.Log.ObsRegister(0, nil, change.UpdateFunc(func(_ any, e change.Event) {
	ce := e.(change.Changed[bool])
	fmt.Printf("%t -> %t", ce.OldValue(), ce.NewValue())
}))
json.NewEncoder(os.Stdout).Encode(&cfg)
json.Unmarshal([]byte(`{"Log": true}`), &cfg)

Output:

{"Log":false}
false -> true

func NewObs

func NewObs[T comparable](init T, defaultTag interface{}, defaultChg change.Flags, os ...change.Observer) Obs[T]

func (*Obs[T]) Flag

func (o *Obs[T]) Flag(name, usage string, set *flag.FlagSet)

func (*Obs[T]) Get

func (o *Obs[T]) Get() T

func (*Obs[T]) MarshalJSON

func (o *Obs[T]) MarshalJSON() ([]byte, error)

func (*Obs[T]) MergeDaQ

func (o *Obs[T]) MergeDaQ(by *daq.Merge, add any) error

func (*Obs[T]) Set

func (o *Obs[T]) Set(v T, chg change.Flags) change.Flags

func (*Obs[T]) UnmarshalJSON

func (o *Obs[T]) UnmarshalJSON(data []byte) error

type On

type On[T comparable] struct {
	change.On[T]
	// contains filtered or unexported fields
}

Example (Json)

cfg := struct {
	Log On[bool]
}{
	Log: NewOn(false, testHook[bool](os.Stdout)),
}
json.NewEncoder(os.Stdout).Encode(&cfg)
json.Unmarshal([]byte(`{"Log": true}`), &cfg)

Output:

{"Log":false}
false -> true

func NewOn

func NewOn[T comparable](init T, hook change.HookFunc[T]) On[T]

func (*On[T]) Flag

func (o *On[T]) Flag(name, usage string, set *flag.FlagSet)

func (*On[T]) Get

func (cv *On[T]) Get() T

func (*On[T]) MarshalJSON

func (o *On[T]) MarshalJSON() ([]byte, error)

func (*On[T]) MergeDaQ

func (o *On[T]) MergeDaQ(by *daq.Merge, add any) error

func (*On[T]) Set

func (cv *On[T]) Set(v T, chg change.Flags) change.Flags

func (*On[T]) UnmarshalJSON

func (o *On[T]) UnmarshalJSON(data []byte) error

type ReloadLog

type ReloadLog interface {
	WatchError(path string, err error)
	Reload(path string)
	ReloadError(path string, err error)
}

func StdLog

func StdLog(l *log.Logger) ReloadLog