defaults

Documentation

Index

• func ReadFrom(path, fallbackPath string, value any) error
• func Set(value interface{}) error
• func Validate(value interface{}) error
• type Decoder
• type JSONDecoder
  • func NewJSONDecoder(r io.Reader) *JSONDecoder
• type TOMLDecoder
  • func NewTOMLDecoder(r io.Reader) *TOMLDecoder
  • func (d *TOMLDecoder) Decode(value interface{}) error
  • func (d *TOMLDecoder) DisallowUnknownFields()

Functions

func ReadFrom

func ReadFrom(path, fallbackPath string, value any) error

ReadFrom reads a configuration file to the value. This function will try to read from given path, if it is empty will try fallback path. If it fails on fallback, it will set value to its defaults

func Set

func Set(value interface{}) error

Set sets the default values to fields

func Validate

func Validate(value interface{}) error

Validate validates each field of the value

Types

type Decoder

type Decoder interface {
	Decode(value any) error
	DisallowUnknownFields()
}

type JSONDecoder

type JSONDecoder struct {
	*json.Decoder
}

func NewJSONDecoder

func NewJSONDecoder(r io.Reader) *JSONDecoder

type TOMLDecoder

type TOMLDecoder struct {
	*toml.Decoder
}

func NewTOMLDecoder

func NewTOMLDecoder(r io.Reader) *TOMLDecoder

func (*TOMLDecoder) Decode

func (d *TOMLDecoder) Decode(value interface{}) error

func (*TOMLDecoder) DisallowUnknownFields

func (d *TOMLDecoder) DisallowUnknownFields()

DisallowUnknownFields will disallow unknown fields in the TOML file. Override this method to ensure Decoder interface is met