config

Documentation

Index

• type Config
  • func New(opts ...Option) (*Config, error)
  • func (c *Config) Delete(key string)
  • func (c *Config) Mandatory() Mandatory
  • func (c *Config) Optional() Optional
  • func (c *Config) Read(ptr any) error
  • func (c *Config) Set(key string, value any)
• type Mandatory
  • func (m Mandatory) Bool(key string) (bool, error)
  • func (m Mandatory) Duration(key string) (time.Duration, error)
  • func (m Mandatory) Int(key string) (int, error)
  • func (m Mandatory) String(key string) (string, error)
• type Option
  • func WithEnvPrefix(prefix string) Option
  • func WithExtraSource(source Source) Option
  • func WithValidator(validator Validator) Option
• type Optional
  • func (o Optional) Bool(key string, defValue bool) bool
  • func (o Optional) Duration(key string, defValue time.Duration) time.Duration
  • func (o Optional) Int(key string, defValue int) int
  • func (o Optional) String(key string, defValue string) string
• type Source
• type Validator
• type YamlFileSource
  • func NewYamlConfig(file string) YamlFileSource
  • func (y YamlFileSource) Config() (map[string]string, error)

Types

type Config

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

func New

func New(opts ...Option) (*Config, error)

func (*Config) Delete

func (c *Config) Delete(key string)

func (*Config) Mandatory

func (c *Config) Mandatory() Mandatory

func (*Config) Optional

func (c *Config) Optional() Optional

func (*Config) Read

func (c *Config) Read(ptr any) error

func (*Config) Set

func (c *Config) Set(key string, value any)

type Mandatory

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

func (Mandatory) Bool

func (m Mandatory) Bool(key string) (bool, error)

func (Mandatory) Duration

func (m Mandatory) Duration(key string) (time.Duration, error)

func (Mandatory) Int

func (m Mandatory) Int(key string) (int, error)

func (Mandatory) String

func (m Mandatory) String(key string) (string, error)

type Option

type Option func(l *Config)

func WithEnvPrefix

func WithEnvPrefix(prefix string) Option

func WithExtraSource

func WithExtraSource(source Source) Option

func WithValidator

func WithValidator(validator Validator) Option

type Optional

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

func (Optional) Bool

func (o Optional) Bool(key string, defValue bool) bool

func (Optional) Duration

func (o Optional) Duration(key string, defValue time.Duration) time.Duration

func (Optional) Int

func (o Optional) Int(key string, defValue int) int

func (Optional) String

func (o Optional) String(key string, defValue string) string

type Source

type Source interface {
	Config() (map[string]string, error)
}

type Validator

type Validator interface {
	ValidateToError(value any) error
}

type YamlFileSource

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

func NewYamlConfig

func NewYamlConfig(file string) YamlFileSource

func (YamlFileSource) Config

func (y YamlFileSource) Config() (map[string]string, error)