config

Documentation

Overview

Package config is an interface for dynamic configuration.

Index

• Variables
• func Load(ctx context.Context, cs ...Config) error
• func NewContext(ctx context.Context, c Config) context.Context
• type Config
  • func FromContext(ctx context.Context) (Config, bool)
  • func NewConfig(opts ...Option) Config
• type Option
  • func AfterLoad(fn ...func(context.Context, Config) error) Option
  • func AfterSave(fn ...func(context.Context, Config) error) Option
  • func AllowFail(b bool) Option
  • func BeforeLoad(fn ...func(context.Context, Config) error) Option
  • func BeforeSave(fn ...func(context.Context, Config) error) Option
  • func Codec(c codec.Codec) Option
  • func Context(ctx context.Context) Option
  • func Logger(l logger.Logger) Option
  • func Name(n string) Option
  • func SetOption(k, v interface{}) Option
  • func Struct(v interface{}) Option
  • func StructTag(name string) Option
  • func Tracer(t tracer.Tracer) Option
• type Options
  • func NewOptions(opts ...Option) Options

Variables

var (
	// ErrCodecMissing is returned when codec needed and not specified
	ErrCodecMissing = errors.New("codec missing")
	// ErrInvalidStruct is returned when the target struct is invalid
	ErrInvalidStruct = errors.New("invalid struct specified")
	// ErrWatcherStopped is returned when source watcher has been stopped
	ErrWatcherStopped = errors.New("watcher stopped")
)

Functions

func Load

func Load(ctx context.Context, cs ...Config) error

Load loads config from config sources

func NewContext

func NewContext(ctx context.Context, c Config) context.Context

NewContext put store in context

Types

type Config

type Config interface {
	Name() string
	// Init the config
	Init(opts ...Option) error
	// Options in the config
	Options() Options
	// Load config from sources
	Load(context.Context) error
	// Save config to sources
	Save(context.Context) error
	// Watch a value for changes
	//	Watch(interface{}) (Watcher, error)
	String() string
}

Config is an interface abstraction for dynamic configuration

var (
	// DefaultConfig default config
	DefaultConfig Config = NewConfig()
)

func FromContext

func FromContext(ctx context.Context) (Config, bool)

FromContext returns store from context

func NewConfig

func NewConfig(opts ...Option) Config

NewConfig returns new default config source

type Option

type Option func(o *Options)

Option function signature

func AfterLoad

func AfterLoad(fn ...func(context.Context, Config) error) Option

AfterLoad run funcs after config load

func AfterSave

func AfterSave(fn ...func(context.Context, Config) error) Option

AfterSave run fncs after save

func AllowFail

func AllowFail(b bool) Option

AllowFail allows config source to fail

func BeforeLoad

func BeforeLoad(fn ...func(context.Context, Config) error) Option

BeforeLoad run funcs before config load

func BeforeSave

func BeforeSave(fn ...func(context.Context, Config) error) Option

BeforeSave run funcs before save

func Codec

func Codec(c codec.Codec) Option

Codec sets the source codec

func Context

func Context(ctx context.Context) Option

Context pass context

func Logger

func Logger(l logger.Logger) Option

Logger sets the logger

func Name

func Name(n string) Option

Name sets the name

func SetOption

func SetOption(k, v interface{}) Option

SetOption returns a function to setup a context with given value

func Struct

func Struct(v interface{}) Option

Struct used as config

func StructTag

func StructTag(name string) Option

StructTag sets the struct tag that used for filling

func Tracer

func Tracer(t tracer.Tracer) Option

Tracer to be used for tracing

type Options

type Options struct {
	// Struct holds the destination config struct
	Struct interface{}
	// Codec that used for load/save
	Codec codec.Codec
	// Tracer that will be used
	Tracer tracer.Tracer
	// Meter that will be used
	Meter meter.Meter
	// Logger that will be used
	Logger logger.Logger
	// Context used for external options
	Context context.Context
	// Name of the config
	Name string
	// StructTag name
	StructTag string
	// BeforeSave contains slice of funcs that runs before save
	BeforeSave []func(context.Context, Config) error
	// AfterLoad contains slice of funcs that runs after load
	AfterLoad []func(context.Context, Config) error
	// BeforeLoad contains slice of funcs that runs before load
	BeforeLoad []func(context.Context, Config) error
	// AfterSave contains slice of funcs that runs after save
	AfterSave []func(context.Context, Config) error
	// AllowFail flag to allow fail in config source
	AllowFail bool
}

Options hold the config options

func NewOptions

func NewOptions(opts ...Option) Options

NewOptions new options struct with filed values