configx

Documentation

Index

• Variables
• func FormatPath(ii ...interface{}) string
• func StringToKeys(s ...string) []string
• func Walk(v Values, fn WalkFunc) error
• type Decrypter
• type Encrypter
• type Entrypoint
• type KV
• type KVStore
• type Key
• type Marshaller
• type Option
  • func WithDecrypt(d Decrypter) Option
  • func WithEncrypt(e Encrypter) Option
  • func WithJSON() Option
  • func WithLock(m *sync.RWMutex) Option
  • func WithMarshaller(m Marshaller) Option
  • func WithReadOnly() Option
  • func WithSetCallback(f func([]string, interface{}) error) Option
  • func WithString() Option
  • func WithUnmarshaler(u Unmarshaler) Option
  • func WithYAML() Option
• type Options
• type Receiver
• type Ref
  • func GetReference(i interface{}) (Ref, bool)
  • func Reference(s string) Ref
• type Scanner
• type Source
• type Unmarshaler
• type Value
• type Values
  • func New(opts ...Option) Values
  • func NewFrom(i interface{}) Values
• type WalkFunc
• type WatchOption
  • func WithChangesOnly() WatchOption
  • func WithPath(path ...string) WatchOption
• type WatchOptions
• type Watcher

Variables

var (
	ErrNoMarshallerDefined  = errors.New("no marshaller defined")
	ErrNoUnmarshalerDefined = errors.New("no unmarshaler defined")
)

Functions

func FormatPath

func FormatPath(ii ...interface{}) string

func StringToKeys

func StringToKeys(s ...string) []string

func Walk

func Walk(v Values, fn WalkFunc) error

Types

type Decrypter

type Decrypter interface {
	Decrypt(string) ([]byte, error)
}

type Encrypter

type Encrypter interface {
	Encrypt([]byte) (string, error)
}

type Entrypoint

type Entrypoint interface {
	KVStore
	Val(path ...string) Values
}

type KV

type KV struct {
	Key   string
	Value interface{}
}

TODO - we should be returning a Value

type KVStore

type KVStore interface {
	Get() Value
	Set(value interface{}) error
	Del() error
}

type Key

type Key interface{}

type Marshaller

type Marshaller interface {
	Marshal(interface{}) ([]byte, error)
}

type Option

type Option func(*Options)

func WithDecrypt

func WithDecrypt(d Decrypter) Option

func WithEncrypt

func WithEncrypt(e Encrypter) Option

func WithJSON

func WithJSON() Option

func WithLock

func WithLock(m *sync.RWMutex) Option

func WithMarshaller

func WithMarshaller(m Marshaller) Option

func WithReadOnly

func WithReadOnly() Option

func WithSetCallback

func WithSetCallback(f func([]string, interface{}) error) Option

func WithString

func WithString() Option

func WithUnmarshaler

func WithUnmarshaler(u Unmarshaler) Option

func WithYAML

func WithYAML() Option

type Options

type Options struct {
	*sync.RWMutex
	Unmarshaler
	Marshaller
	Encrypter
	Decrypter

	// Additional callback after Set is called
	SetCallback func([]string, interface{}) error

	// Do not create any resources
	ReadOnly bool

	// Used to pass other potential options
	Context context.Context
}

type Receiver

type Receiver interface {
	Next() (interface{}, error)
	Stop()
}

type Ref

type Ref interface {
	Get() string
}

func GetReference

func GetReference(i interface{}) (Ref, bool)

func Reference

func Reference(s string) Ref

type Scanner

type Scanner interface {
	Scan(interface{}, ...Option) error
}

type Source

type Source interface {
	Entrypoint
	Watcher
}

type Unmarshaler

type Unmarshaler interface {
	Unmarshal([]byte, interface{}) error
}

type Value

type Value interface {
	Default(interface{}) Value

	Bool() bool
	Bytes() []byte
	Key() []string
	Reference() Ref
	Interface() interface{}
	Int() int
	Int64() int64
	Duration() time.Duration
	String() string
	StringMap() map[string]string
	StringArray() []string
	Slice() []interface{}
	Map() map[string]interface{}

	Scanner
}

type Values

type Values interface {
	Entrypoint
	Value
}

func New

func New(opts ...Option) Values

func NewFrom

func NewFrom(i interface{}) Values

type WalkFunc

type WalkFunc func(key []string, v Value) error

type WatchOption

type WatchOption func(*WatchOptions)

func WithChangesOnly

func WithChangesOnly() WatchOption

func WithPath

func WithPath(path ...string) WatchOption

type WatchOptions

type WatchOptions struct {
	Path        []string
	ChangesOnly bool
}

type Watcher

type Watcher interface {
	Watch(opts ...WatchOption) (Receiver, error)
}