config

Documentation

Overview

Package config provides helpers for toml based config files

Index

• func AsValidationErrors(err error) (validator.ValidationErrors, bool)
• func LoadFile(filename string, v any) error
• func Prepare(v any) error
• func SetDefaults(v any) error
• func Validate(v any) error
• func WriteTo(f io.Writer, v any) (int64, error)

Functions

func AsValidationErrors

func AsValidationErrors(err error) (validator.ValidationErrors, bool)

AsValidationErrors gives access to a slice of validator.FieldError

func LoadFile

func LoadFile(filename string, v any) error

LoadFile reads a TOML encoded files applying shell expansions for environment variables into a configuration struct

func Prepare

func Prepare(v any) error

Prepare runs SetDefaults and Validate

func SetDefaults

func SetDefaults(v any) error

SetDefaults applies `defaults` structtags and SetDefaults() recursively

func Validate

func Validate(v any) error

Validate validates exposed fields including nested structs

func WriteTo

func WriteTo(f io.Writer, v any) (int64, error)

WriteTo writes to a given io.Writer the TOML encoded representation of a configuration struct