env

README

== Core utils

. Used by https://github.com/caarlos0/env[env]

Documentation

Index

• Constants
• Variables
• func ReadEnvConfig(cfg any) error
• func ReadEnvConfigWithOptions(cfg any, opts *env.Options) error
• func SlogAttrEnv[E ListOrMap](env E) slog.Attr
• type List
  • func MapToSlices(envMap Map) List
• type ListOrMap
• type Map
  • func MergeEnvs[E ListOrMap](source E, additions ...Map) Map
  • func SlicesToMap(env List) Map

Constants

const (
	KeyPath   = "PATH"
	KeyGoBin  = "GOBIN"
	KeyGoPath = string(vfs.RootTypeGoPath)
	KeyGoRoot = string(vfs.RootTypeGoRoot)
)

Variables

var (
	ErrFailedReadConfiguration = errors.New("failed to read configuration from environment")
)

Functions

func ReadEnvConfig

func ReadEnvConfig(cfg any) error

func ReadEnvConfigWithOptions

func ReadEnvConfigWithOptions(cfg any, opts *env.Options) error

func SlogAttrEnv

func SlogAttrEnv[E ListOrMap](env E) slog.Attr

Types

type List

type List = []string

func MapToSlices

func MapToSlices(envMap Map) List

type ListOrMap

type ListOrMap interface {
	List | Map
}

type Map

type Map = map[string]string

func MergeEnvs

func MergeEnvs[E ListOrMap](source E, additions ...Map) Map

func SlicesToMap

func SlicesToMap(env List) Map