config

Documentation

Overview

Package config contains helpers for loading and dumping TOML config files

Index

• Variables
• func LoadFile(filename string, v any) error
• func Prepare(v any) error
• func WriteTo(v any, w io.Writer) (int64, error)

Variables

var (
	// Indent is the string used for indenting TOML files when encoding them
	Indent = `  `
)

Functions

func LoadFile

func LoadFile(filename string, v any) error

LoadFile loads a TOML file by name, expanding environment variables, filling gaps and validating its content.

func Prepare

func Prepare(v any) error

Prepare fills any gap in the object and validates its content.

func WriteTo

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

WriteTo writes out the object encoded as TOML.