archivist

Documentation

Index

• Constants
• Variables
• func ConfGroup() string
• func ConfSubgroup() string
• func Dump(c Collection, outputDir string) error
• func MustHaveConfGroup()
• type Archivist
  • func NewArchivist(opts ...Option) *Archivist
  • func (this *Archivist) FindCollection(version string) (Collection, error)
  • func (this *Archivist) LoadCollection(newCollection func() interface{}, overwrites ...Overwrite) (Collection, error)
  • func (this *Archivist) PatchCollection(coll Collection, overwrites ...Overwrite) (Collection, error)
  • func (this *Archivist) SetCurrentCollection(c Collection)
• type Collection
• type CollectionWrapper
• type I18n
  • func (s I18n) I18n(lang string) string
  • func (s I18n) Sprintf(lang string, a ...interface{}) (string, error)
• type Option
  • func WithBlacklist(blacklist []string) Option
  • func WithLogger(log slog.Logger) Option
  • func WithReloadCallback(f func(newC, oldC Collection) error) Option
  • func WithRoot(root string) Option
  • func WithWhitelist(whitelist []string) Option
• type Overwrite

Constants

const EnvName_ConfGroup = "WATCHER_CONF_GROUP"

const EnvName_ConfSubgroup = "WATCHER_CONF_SUBGROUP"

Variables

var (
	ErrUpgradeNeeded = fmt.Errorf("%s", "configuration upgrade needed")
)

var (
	ResolveI18n func(lang, key string) string
)

Functions

func ConfGroup

func ConfGroup() string

func ConfSubgroup

func ConfSubgroup() string

func Dump

func Dump(c Collection, outputDir string) error

func MustHaveConfGroup

func MustHaveConfGroup()

Types

type Archivist

type Archivist struct {
	slog.Logger
	// contains filtered or unexported fields
}

func NewArchivist

func NewArchivist(opts ...Option) *Archivist

func (*Archivist) FindCollection

func (this *Archivist) FindCollection(version string) (Collection, error)

func (*Archivist) LoadCollection

func (this *Archivist) LoadCollection(newCollection func() interface{}, overwrites ...Overwrite) (Collection, error)

func (*Archivist) PatchCollection

func (this *Archivist) PatchCollection(coll Collection, overwrites ...Overwrite) (Collection, error)

func (*Archivist) SetCurrentCollection

func (this *Archivist) SetCurrentCollection(c Collection)

type Collection

type Collection interface {
	CompatibleVersions() []string
	Filename2Conf() map[string]interface{}
	RevRefGraph() map[string][]string
	BindRefs() error
	FixPointers()
}

type CollectionWrapper

type CollectionWrapper struct {
	Collection
	// contains filtered or unexported fields
}

type I18n

type I18n string

func (I18n) I18n

func (s I18n) I18n(lang string) string

func (I18n) Sprintf

func (s I18n) Sprintf(lang string, a ...interface{}) (string, error)

type Option

type Option func(arch *Archivist)

func WithBlacklist

func WithBlacklist(blacklist []string) Option

func WithLogger

func WithLogger(log slog.Logger) Option

func WithReloadCallback

func WithReloadCallback(f func(newC, oldC Collection) error) Option

func WithRoot

func WithRoot(root string) Option

func WithWhitelist

func WithWhitelist(whitelist []string) Option

type Overwrite

type Overwrite struct {
	FileLevel bool
	Target    string
	Data      []byte
}