config

Documentation

Overview

Package config defines a manager to manage common configuration.

Index

• type Manager
  • func New(name string) *Manager
  • func (mgr *Manager) AddConfigFlag(persistentFlags *pflag.FlagSet)
  • func (mgr *Manager) Flags() *pflag.FlagSet
  • func (mgr *Manager) InitFlags(cfg any) error
  • func (mgr *Manager) ReadFromFile(fs *pflag.FlagSet) error
  • func (mgr *Manager) Unmarshal(config interface{}) error
  • func (mgr *Manager) Viper() *viper.Viper

Types

type Manager

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

Manager is the configuration manager.

func New

func New(name string) *Manager

New returns a new initialized manager with the given config.

func (*Manager) AddConfigFlag

func (mgr *Manager) AddConfigFlag(persistentFlags *pflag.FlagSet)

AddConfigFlag adds the config flag to the persistent root flagset.

func (*Manager) Flags

func (mgr *Manager) Flags() *pflag.FlagSet

Flags returns pflag.FlagSet.

func (*Manager) InitFlags

func (mgr *Manager) InitFlags(cfg any) error

InitFlags initializes the flagset with the provided config.

func (*Manager) ReadFromFile

func (mgr *Manager) ReadFromFile(fs *pflag.FlagSet) error

ReadFromFile reads the config from the file set with the `config` flag. Use `AddConfigFlag` to add the config flag to the root flagset.

func (*Manager) Unmarshal

func (mgr *Manager) Unmarshal(config interface{}) error

Unmarshal unmarshals the read config into the provided struct.

func (*Manager) Viper

func (mgr *Manager) Viper() *viper.Viper

Viper returns viper.