config

Documentation

Index

• func LoadConfig[T any](defaults T, flags *pflag.FlagSet, opts ...LoadOption) (*T, error)
• type Config
  • func NewConfig(opts ...Option) (Config, error)
• type EnvSource
  • func NewEnvSource(opts ...EnvSourceOption) (*EnvSource, error)
  • func (es *EnvSource) Load() (map[string]any, error)
  • func (es *EnvSource) Watch() (Watcher, error)
• type EnvSourceOption
  • func WithEnvNameMapping(nameMappings map[string]string) EnvSourceOption
  • func WithEnvPrefix(prefix string) EnvSourceOption
• type FileSource
  • func NewFileSource(opts ...FileSourceOption) (*FileSource, error)
  • func (fs *FileSource) Load() (map[string]any, error)
  • func (fs *FileSource) Watch() (Watcher, error)
• type FileSourceOption
  • func WithFilePath(files ...string) FileSourceOption
• type FlagSource
  • func NewFlagSource(flags *pflag.FlagSet, opts ...FlagSourceOption) (*FlagSource, error)
  • func (fs *FlagSource) Load() (map[string]any, error)
  • func (fs *FlagSource) Watch() (Watcher, error)
• type FlagSourceOption
• type LoadOption
  • func WithDefaultValueOptions(defaults any) LoadOption
  • func WithEnvOptions(opts ...EnvSourceOption) LoadOption
  • func WithFileOptions(opts ...FileSourceOption) LoadOption
  • func WithFlagOptions(opts ...FlagSourceOption) LoadOption
  • func WithValueTagOptions(opts ...ValueSourceOption) LoadOption
• type Option
  • func WithDelimiter(delim string) Option
  • func WithSource(sources ...Source) Option
• type Source
• type Value
• type ValueSource
  • func NewValueSourceFromMap(value map[string]any) (*ValueSource, error)
  • func NewValueSourceFromStruct(defaults any, opts ...ValueSourceOption) (*ValueSource, error)
  • func (ds *ValueSource) Load() (map[string]any, error)
  • func (ds *ValueSource) Watch() (Watcher, error)
• type ValueSourceOption
  • func WithValueTag(tag string) ValueSourceOption
• type Watcher

Functions

func LoadConfig

func LoadConfig[T any](defaults T, flags *pflag.FlagSet, opts ...LoadOption) (*T, error)

Types

type Config

type Config interface {
	Load() error
	Get(key string) Value
	Exists(key string) bool
	Scan(v any) error
	ScanPath(path string, v any) error
	All() map[string]any
	Close() error
}

func NewConfig

func NewConfig(opts ...Option) (Config, error)

type EnvSource

type EnvSource struct {
	// contains filtered or unexported fields
}

EnvSource provides environment variable configuration

func NewEnvSource

func NewEnvSource(opts ...EnvSourceOption) (*EnvSource, error)

NewEnvSource creates a new EnvSource with the given prefix

func (*EnvSource) Load

func (es *EnvSource) Load() (map[string]any, error)

Load returns the configuration data from environment variables

func (*EnvSource) Watch

func (es *EnvSource) Watch() (Watcher, error)

type EnvSourceOption

type EnvSourceOption func(*EnvSource) error

func WithEnvNameMapping

func WithEnvNameMapping(nameMappings map[string]string) EnvSourceOption

WithEnvNameMapping allows setting nameMappings for environment variable names

func WithEnvPrefix

func WithEnvPrefix(prefix string) EnvSourceOption

WithEnvPrefix allows setting a prefix for environment variable names

type FileSource

type FileSource struct {
	// contains filtered or unexported fields
}

FileSource provides file-based configuration

func NewFileSource

func NewFileSource(opts ...FileSourceOption) (*FileSource, error)

NewFileSource creates a new FileSource with the given files

func (*FileSource) Load

func (fs *FileSource) Load() (map[string]any, error)

Load returns the configuration data from files

func (*FileSource) Watch

func (fs *FileSource) Watch() (Watcher, error)

type FileSourceOption

type FileSourceOption func(*FileSource) error

func WithFilePath

func WithFilePath(files ...string) FileSourceOption

type FlagSource

type FlagSource struct {
	// contains filtered or unexported fields
}

FlagSource provides command-line flag configuration

func NewFlagSource

func NewFlagSource(flags *pflag.FlagSet, opts ...FlagSourceOption) (*FlagSource, error)

NewFlagSource creates a new FlagSource with the given flag set

func (*FlagSource) Load

func (fs *FlagSource) Load() (map[string]any, error)

Load returns the configuration data from command-line flags

func (*FlagSource) Watch

func (fs *FlagSource) Watch() (Watcher, error)

type FlagSourceOption

type FlagSourceOption func(*FlagSource) error

type LoadOption

type LoadOption func(*loadOptions)

func WithDefaultValueOptions

func WithDefaultValueOptions(defaults any) LoadOption

func WithEnvOptions

func WithEnvOptions(opts ...EnvSourceOption) LoadOption

func WithFileOptions

func WithFileOptions(opts ...FileSourceOption) LoadOption

func WithFlagOptions

func WithFlagOptions(opts ...FlagSourceOption) LoadOption

func WithValueTagOptions

func WithValueTagOptions(opts ...ValueSourceOption) LoadOption

type Option

type Option func(*config) error

func WithDelimiter

func WithDelimiter(delim string) Option

func WithSource

func WithSource(sources ...Source) Option

type Source

type Source interface {
	// Load returns the configuration data from this source
	Load() (map[string]any, error)
	Watch() (Watcher, error)
}

Source defines the interface for configuration sources

type Value

type Value interface {
	Bool() (bool, error)
	Int() (int64, error)
	Float() (float64, error)
	String() (string, error)
	Duration() (time.Duration, error)
	Slice() ([]Value, error)
	Map() (map[string]Value, error)
	Scan(any) error
	Load() any
	Store(any)
}

type ValueSource

type ValueSource struct {
	// contains filtered or unexported fields
}

ValueSource provides default configuration values

func NewValueSourceFromMap

func NewValueSourceFromMap(value map[string]any) (*ValueSource, error)

NewValueSourceFromMap creates a new ValueSource with the given value

func NewValueSourceFromStruct

func NewValueSourceFromStruct(defaults any, opts ...ValueSourceOption) (*ValueSource, error)

NewValueSourceFromStruct creates a ValueSource from a struct

func (*ValueSource) Load

func (ds *ValueSource) Load() (map[string]any, error)

Load returns the default configuration data

func (*ValueSource) Watch

func (ds *ValueSource) Watch() (Watcher, error)

type ValueSourceOption

type ValueSourceOption func(*ValueSource) error

func WithValueTag

func WithValueTag(tag string) ValueSourceOption

WithValueTag sets the tag used for struct fields in ValueSource

type Watcher

type Watcher interface {
	Next() (map[string]any, error)
	Stop() error
}