loader

Documentation

Index

• Variables
• type Loader
• type Option
  • func WithReader(r reader.Reader) Option
  • func WithSource(s source.Source) Option
• type Options
• type Snapshot
  • func Copy(s *Snapshot) *Snapshot

Variables

var (
	ErrNotLoaded        = errors.New("not loaded config yet")
	ErrLoaderStop       = errors.New("config loader has been close")
	ErrNotSupportReload = errors.New("current config loader not support reload")
)

Types

type Loader

type Loader interface {
	// Close will stop the loader
	Close() error
	// Load the sources
	Load(...source.Source) error
	// A Snapshot of loaded config
	Snapshot() (*Snapshot, error)
	// Next will return the updated data, when the configuration data is updated
	Next() (*Snapshot, error)
	// String is the name of loader
	String() string
}

Loader manages loading sources

type Option

type Option func(o *Options)

func WithReader

func WithReader(r reader.Reader) Option

WithReader sets the config reader

func WithSource

func WithSource(s source.Source) Option

type Options

type Options struct {
	Reader reader.Reader
	Source []source.Source
}

type Snapshot

type Snapshot struct {
	// The merged ChangeSet
	ChangeSet *source.ChangeSet
	// Deterministic and comparable version of the snapshot
	Version string
}

Snapshot is a merged ChangeSet

func Copy

func Copy(s *Snapshot) *Snapshot

Copy snapshot