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) (SourceConfig, error)
• type Builder
  • func NewBuilder() Builder
• type Config
  • func (c *Config) GetEnv(key string) (string, bool)
  • func (c *Config) LoadFromFile(path string, opts ...SourceOption) error
  • func (c *Config) SetEnv(key, value string)
  • func (c *Config) Setup(prefix string) error
• type Decoder
• 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 KeyValue
• type Merge
• type Observer
• type Option
• type OptionSetting
  • func WithOptions(options ...SourceOption) OptionSetting
• type Reader
• type Resolver
• type Source
• type SourceConfig
  • func NewSourceConfig(opts ...SourceOption) SourceConfig
• type SourceOption
  • func WithDecoder(d Decoder) SourceOption
  • func WithMergeFunc(m Merge) SourceOption
  • func WithResolveActualTypes(enableConvertToType bool) SourceOption
  • func WithResolver(r Resolver) SourceOption
  • func WithSource(s ...Source) SourceOption
• type Syncer
• type Value
• type Watcher

Variables

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

Types

type BuildFunc

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

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

func (BuildFunc) NewConfig

func (fn BuildFunc) NewConfig(cfg *configv1.SourceConfig, ss ...OptionSetting) (SourceConfig, 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 {
	EnvPrefixes []string
	// 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 ...SourceOption) error

func (*Config) SetEnv

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

func (*Config) Setup

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

type Decoder

type Decoder = kratosconfig.Decoder

Define types from kratos config package

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 SourceConfig and a list of Options.
	NewConfig(*configv1.SourceConfig, ...OptionSetting) (SourceConfig, error)
}

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

type KeyValue

type KeyValue = kratosconfig.KeyValue

Define types from kratos config package

type Merge

type Merge = kratosconfig.Merge

Define types from kratos config package

type Observer

type Observer = kratosconfig.Observer

Define types from kratos config package

type Option

type Option struct {
	SourceOptions []SourceOption
	Decoder       Decoder
	Encoder       Encoder
}

type OptionSetting

type OptionSetting = func(s *Option)

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

func WithOptions

func WithOptions(options ...SourceOption) OptionSetting

WithOptions sets the options field of the SourceOption struct.

type Reader

type Reader = kratosconfig.Reader

Define types from kratos config package

type Resolver

type Resolver = kratosconfig.Resolver

Define types from kratos config package

type Source

type Source = kratosconfig.Source

Define types from kratos config package

type SourceConfig

type SourceConfig = kratosconfig.Config

Define types from kratos config package

func NewSourceConfig

func NewSourceConfig(opts ...SourceOption) SourceConfig

NewSourceConfig returns a new config instance

type SourceOption

type SourceOption = kratosconfig.Option

Define types from kratos config package

func WithDecoder

func WithDecoder(d Decoder) SourceOption

WithDecoder sets the decoder

func WithMergeFunc

func WithMergeFunc(m Merge) SourceOption

WithMergeFunc sets the merge function

func WithResolveActualTypes

func WithResolveActualTypes(enableConvertToType bool) SourceOption

WithResolveActualTypes enables resolving actual types

func WithResolver

func WithResolver(r Resolver) SourceOption

WithResolver sets the resolver

func WithSource

func WithSource(s ...Source) SourceOption

WithSource sets the source

type Syncer

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

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

type Value

type Value = kratosconfig.Value

Define types from kratos config package

type Watcher

type Watcher = kratosconfig.Watcher

Define types from kratos config package