config

Documentation

Index

• func NewPathResolver() *defaultPathResolver
• type ConfigSource
• type EnvVarSource
  • func (e *EnvVarSource) Read() ([]byte, error)
• type FileSystemSource
  • func (f *FileSystemSource) Read() ([]byte, error)
• type Loader
  • func NewLoader(pathResolver PathResolver) *Loader
  • func (c *Loader) InitConfig(config any, configName, configFolderPath string) error
• type Manager
  • func NewManager(parser Parser) *Manager
  • func (cm *Manager) AddSource(source ConfigSource)
  • func (cm *Manager) Load(config any) error
• type Parser
• type PathResolver
• type YAMLParser
  • func (y *YAMLParser) Parse(data []byte, out any) error

Functions

func NewPathResolver

func NewPathResolver() *defaultPathResolver

NewPathResolver creates a new instance of the default path resolver.

Types

type ConfigSource

type ConfigSource interface {
	Read() ([]byte, error)
}

ConfigSource configuring source interfaces.

type EnvVarSource

type EnvVarSource struct {
	VarName string
}

EnvVarSource read a configuration from an environment variable.

func (*EnvVarSource) Read

func (e *EnvVarSource) Read() ([]byte, error)

type FileSystemSource

type FileSystemSource struct {
	FilePath string
}

FileSystemSource read a configuration from a file.

func (*FileSystemSource) Read

func (f *FileSystemSource) Read() ([]byte, error)

type Loader

type Loader struct {
	PathResolver PathResolver
}

Loader is responsible for loading configuration files.

func NewLoader

func NewLoader(pathResolver PathResolver) *Loader

func (*Loader) InitConfig

func (c *Loader) InitConfig(config any, configName, configFolderPath string) error

type Manager

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

func NewManager

func NewManager(parser Parser) *Manager

func (*Manager) AddSource

func (cm *Manager) AddSource(source ConfigSource)

func (*Manager) Load

func (cm *Manager) Load(config any) error

type Parser

type Parser interface {
	Parse(data []byte, out any) error
}

Parser Configures the parser interface.

type PathResolver

type PathResolver interface {
	GetDefaultConfigPath() (string, error)
	GetProjectRoot() (string, error)
}

PathResolver defines methods for resolving paths related to the application.

type YAMLParser

type YAMLParser struct{}

YAMLParser Configuration parser in YAML format.

func (*YAMLParser) Parse

func (y *YAMLParser) Parse(data []byte, out any) error