taurus

README

Taurus

Taurus is a simple configuration library for Go. It was originally developed as part of LibraCore to replace Viper.

The Viper configuration library is great, but it didn't quite fit Libra's needs. Taurus is meant to provide the main features of Viper without all of its complexity.

Documentation

Index

• func BindEnvAlias(fieldPath string, aliases ...string)
• func BindFlag(fieldPath string, flag *pflag.Flag)
• func Load(configData string, cfg interface{}) error
• func LoadEnv(prefix string, cfg interface{}) error
• func LoadFile(configFilePath string, cfg interface{}) error
• func LoadFlags(cfg interface{}) error
• func RegisterMarshaler[T any](ta *Taurus, marshaler func(T) ([]byte, error))
• func RegisterUnmarshaler[T any](ta *Taurus, unmarshaler func(*T, []byte) error)
• func SetEnvPrefix(prefix string)
• func SetExpandEnv(expand bool)
• func SetStripUnmarshaledStrings(strip bool)
• type Taurus
  • func New() *Taurus
  • func (t *Taurus) BindEnvAlias(fieldPath string, aliases ...string)
  • func (t *Taurus) BindFlag(fieldPath string, flag *pflag.Flag)
  • func (t *Taurus) Load(configData string, cfg interface{}) error
  • func (t *Taurus) LoadEnv(prefix string, cfg interface{}) error
  • func (t *Taurus) LoadFile(configFilePath string, cfg interface{}) error
  • func (t *Taurus) LoadFlags(cfg interface{}) error
  • func (t *Taurus) SetEnvPrefix(prefix string)
  • func (t *Taurus) SetExpandEnv(expand bool)
  • func (t *Taurus) SetStripUnmarshaledStrings(strip bool)

Functions

func BindEnvAlias

func BindEnvAlias(fieldPath string, aliases ...string)

func BindFlag

func BindFlag(fieldPath string, flag *pflag.Flag)

func Load

func Load(configData string, cfg interface{}) error

func LoadEnv

func LoadEnv(prefix string, cfg interface{}) error

func LoadFile

func LoadFile(configFilePath string, cfg interface{}) error

func LoadFlags

func LoadFlags(cfg interface{}) error

func RegisterMarshaler

func RegisterMarshaler[T any](ta *Taurus, marshaler func(T) ([]byte, error))

RegisterMarshaler registers a custom marshaler for the type argument T. If the parameter "t" is nil, the default Taurus instance is used.

func RegisterUnmarshaler

func RegisterUnmarshaler[T any](ta *Taurus, unmarshaler func(*T, []byte) error)

RegisterUnmarshaler registers a custom unmarshaler for the type argument T. If the parameter "t" is nil, the default Taurus instance is used.

func SetEnvPrefix

func SetEnvPrefix(prefix string)

func SetExpandEnv

func SetExpandEnv(expand bool)

func SetStripUnmarshaledStrings

func SetStripUnmarshaledStrings(strip bool)

Types

type Taurus

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

func New

func New() *Taurus

func (*Taurus) BindEnvAlias

func (t *Taurus) BindEnvAlias(fieldPath string, aliases ...string)

func (*Taurus) BindFlag

func (t *Taurus) BindFlag(fieldPath string, flag *pflag.Flag)

func (*Taurus) Load

func (t *Taurus) Load(configData string, cfg interface{}) error

func (*Taurus) LoadEnv

func (t *Taurus) LoadEnv(prefix string, cfg interface{}) error

func (*Taurus) LoadFile

func (t *Taurus) LoadFile(configFilePath string, cfg interface{}) error

func (*Taurus) LoadFlags

func (t *Taurus) LoadFlags(cfg interface{}) error

func (*Taurus) SetEnvPrefix

func (t *Taurus) SetEnvPrefix(prefix string)

func (*Taurus) SetExpandEnv

func (t *Taurus) SetExpandEnv(expand bool)

func (*Taurus) SetStripUnmarshaledStrings

func (t *Taurus) SetStripUnmarshaledStrings(strip bool)