config

Documentation

Overview

Package config implements the functions, types, and interfaces for the module.

Package config implements the functions, types, and interfaces for the module.

Package config implements the functions, types, and interfaces for the module.

Package config implements the functions, types, and interfaces for the module.

Index

• Variables
• type BuildFunc
  • func (fn BuildFunc) NewConfig(cfg *configv1.SourceConfig, ss ...OptionSetting) (KConfig, error)
• type Builder
  • func NewBuilder() Builder
• type Config
  • func (c *Config) GetEnv(key string) (string, bool)
  • func (c *Config) LoadFromFile(path string, opts ...KOption) error
  • func (c *Config) LoadFromSource(cfg *configv1.SourceConfig, opts ...OptionSetting) error
  • func (c *Config) Scan(v any) error
  • func (c *Config) SetEnv(key, value string)
  • func (c *Config) Setup(prefix string) error
  • func (c *Config) Watch(key string, ob KObserver) error
• type Configure
• type Encoder
• type EnvVars
  • func (v *EnvVars) Get(key string) (string, bool)
  • func (v *EnvVars) Set(key string, value string)
  • func (v *EnvVars) Setup(prefix string) error
• type Factory
• type KConfig
  • func NewSourceConfig(opts ...KOption) KConfig
• type KDecoder
• type KKeyValue
• type KMerge
• type KObserver
• type KOption
  • func WithDecoder(d KDecoder) KOption
  • func WithMergeFunc(m KMerge) KOption
  • func WithResolveActualTypes(enableConvertToType bool) KOption
  • func WithResolver(r KResolver) KOption
  • func WithSource(s ...KSource) KOption
• type KReader
• type KResolver
• type KSource
• type KValue
• type KWatcher
• type Option
• type OptionSetting
  • func WithConfigure(cfg Configure) OptionSetting
  • func WithOptions(options ...KOption) OptionSetting
• type Syncer

Variables

var (
	// ErrNotFound defined error from kratos config package
	ErrNotFound = kratosconfig.ErrNotFound
)

Types

type BuildFunc

type BuildFunc func(*configv1.SourceConfig, ...OptionSetting) (KConfig, error)

BuildFunc is a function type that takes a KConfig and a list of Options and returns a Selector and an error.

func (BuildFunc) NewConfig

func (fn BuildFunc) NewConfig(cfg *configv1.SourceConfig, ss ...OptionSetting) (KConfig, error)

NewConfig is a method that implements the ConfigBuilder interface for ConfigBuildFunc.

type Builder

type Builder interface {
	Factory
	// RegisterConfigBuilder registers a config builder with the given name.
	RegisterConfigBuilder(string, Factory)
}

Builder is an interface that defines a method for registering a config builder.

func NewBuilder

func NewBuilder() Builder

type Config

type Config struct {
	Path        string
	EnvPrefixes []string
	Builder     Builder
	// contains filtered or unexported fields
}

func (*Config) GetEnv

func (c *Config) GetEnv(key string) (string, bool)

func (*Config) LoadFromFile

func (c *Config) LoadFromFile(path string, opts ...KOption) error

func (*Config) LoadFromSource

func (c *Config) LoadFromSource(cfg *configv1.SourceConfig, opts ...OptionSetting) error

func (*Config) Scan

func (c *Config) Scan(v any) error

func (*Config) SetEnv

func (c *Config) SetEnv(key, value string)

func (*Config) Setup

func (c *Config) Setup(prefix string) error

func (*Config) Watch

func (c *Config) Watch(key string, ob KObserver) error

type Configure

type Configure interface {
	FromConfig(cfg *configv1.SourceConfig) error
}

type Encoder

type Encoder func(v any) ([]byte, error)

Encoder is a function that takes a value and returns a byte slice and an error.

type EnvVars

type EnvVars struct {
	KeyValues map[string]string
}

func (*EnvVars) Get

func (v *EnvVars) Get(key string) (string, bool)

func (*EnvVars) Set

func (v *EnvVars) Set(key string, value string)

func (*EnvVars) Setup

func (v *EnvVars) Setup(prefix string) error

type Factory

type Factory interface {
	// NewConfig creates a new config using the given KConfig and a list of Options.
	NewConfig(*configv1.SourceConfig, ...OptionSetting) (KConfig, error)
}

Factory is an interface that defines a method for creating a new config.

type KConfig

type KConfig = kratosconfig.Config

Define types from kratos config package

func NewSourceConfig

func NewSourceConfig(opts ...KOption) KConfig

NewSourceConfig returns a new config instance

type KDecoder

type KDecoder = kratosconfig.Decoder

Define types from kratos config package

type KKeyValue

type KKeyValue = kratosconfig.KeyValue

Define types from kratos config package

type KMerge

type KMerge = kratosconfig.Merge

Define types from kratos config package

type KObserver

type KObserver = kratosconfig.Observer

Define types from kratos config package

type KOption

type KOption = kratosconfig.Option

Define types from kratos config package

func WithDecoder

func WithDecoder(d KDecoder) KOption

WithDecoder sets the decoder

func WithMergeFunc

func WithMergeFunc(m KMerge) KOption

WithMergeFunc sets the merge function

func WithResolveActualTypes

func WithResolveActualTypes(enableConvertToType bool) KOption

WithResolveActualTypes enables resolving actual types

func WithResolver

func WithResolver(r KResolver) KOption

WithResolver sets the resolver

func WithSource

func WithSource(s ...KSource) KOption

WithSource sets the source

type KReader

type KReader = kratosconfig.Reader

Define types from kratos config package

type KResolver

type KResolver = kratosconfig.Resolver

Define types from kratos config package

type KSource

type KSource = kratosconfig.Source

Define types from kratos config package

type KValue

type KValue = kratosconfig.Value

Define types from kratos config package

type KWatcher

type KWatcher = kratosconfig.Watcher

Define types from kratos config package

type Option

type Option struct {
	SourceOptions []KOption
	Decoder       KDecoder
	Encoder       Encoder
	Configure     Configure
}

type OptionSetting

type OptionSetting = func(s *Option)

OptionSetting is a function that takes a pointer to a KOption struct and modifies it.

func WithConfigure

func WithConfigure(cfg Configure) OptionSetting

func WithOptions

func WithOptions(options ...KOption) OptionSetting

WithOptions sets the options field of the KOption struct.

type Syncer

type Syncer interface {
	SyncConfig(*configv1.SourceConfig, any, ...OptionSetting) error
}

Syncer is an interface that defines a method for synchronizing a config.