config

README

Darvaza Config

darvaza.org/x/config provides helpers for dealing with config files.

Default values

Wrappers for github.com/amery/defaults:

• SetDefaults()
• Set()
• CanUpdate()

Environment

Expand shell-style variables:

• FromString()
• FromBytes()
• FromReader()
• FromFile()

Validations

Wrappers for github.com/go-playground/validator/v10:

• Validate()
• AsValidationError()
• and Prepare(). calling SetDefaults() and Validate().

See also

• JPI Technologies' Open Source Software
• darvaza libraries
  • darvaza.org/core
  • darvaza.org/x
• darvaza servers
  • darvaza.org/penne
  • darvaza.org/sidecar
• third party libraries
  • github.com/amery/defaults
  • github.com/go-playground/validator
  • mvdan.cc/sh

Documentation

Overview

Package config provides helpers for handling config structs

Index

• func AsValidationErrors(err error) (validator.ValidationErrors, bool)
• func CanUpdate(v any) bool
• func Prepare(v any) error
• func Set(v any) error
• func SetDefaults(v any) error
• func Validate(v any) error

Functions

func AsValidationErrors

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

AsValidationErrors gives access to a slice of validator.FieldError

func CanUpdate

func CanUpdate(v any) bool

CanUpdate returns true when the given value is an initial value of its type

func Prepare

func Prepare(v any) error

Prepare runs SetDefaults and Validate

func Set

func Set(v any) error

Set applies `default` struct-tags and SetDefaults() recursively. If the given object has a `SetDefaults() error` method, it will be ignored. Any `SetDefaults() error` deeper in the struct will be called.

func SetDefaults

func SetDefaults(v any) error

SetDefaults applies `default` struct-tags and SetDefaults() recursively. If the given object has a `SetDefaults() error` method, it will be invoked instead.

func Validate

func Validate(v any) error

Validate validates exposed fields including nested structs