source

package

v1.1.4 Latest Latest Go to latest Published: Jun 12, 2020 License: Apache-2.0 Imports: 7 Imported by: 0

Details

Package source is the interface for sources

This section is empty.

This section is empty.

This section is empty.

type ChangeSet struct {
	Data      []byte
	Checksum  string
	Format    string
	Source    string
	Timestamp time.Time
}

ChangeSet represents a set of changes from a source

func (c *ChangeSet) Sum() string

Sum returns the md5 checksum of the ChangeSet data

type Option func(o *Options)

func WithEncoder(e encoder.Encoder) Option

WithEncoder sets the source encoder

type Options struct {
	// Encoder
	Encoder encoder.Encoder

	// for alternative data
	Context context.Context
}

func NewOptions(opts ...Option) Options

type Source interface {
	Read() (*ChangeSet, error)
	Watch() (Watcher, error)
	String() string
}

Source is the source from which config is loaded

type Watcher interface {
	Next() (*ChangeSet, error)
	Stop() error
}

Watcher watches a source for changes

func NewNoopWatcher() (Watcher, error)

NewNoopWatcher returns a watcher that blocks on Next() until Stop() is called.

Path	Synopsis
configmap Package configmap config is an interface for dynamic configuration.	Package configmap config is an interface for dynamic configuration.
consul
env
etcd
file Package file is a file source.	Package file is a file source.
flag
grpc
proto Package grpc is a generated protocol buffer package.	Package grpc is a generated protocol buffer package.
memory Package memory is a memory source	Package memory is a memory source
pflag
url Package url loads changesets from a url	Package url loads changesets from a url
vault