env

Documentation

Overview

Package env implements encoding and decoding between environment variable and a typed Configuration.

Index

• Constants
• func Decode(environ []string, prefix string, element interface{}) error
• func Encode(element interface{}) ([]parser.Flat, error)
• func FindPrefixedEnvVars(environ []string, prefix string, element interface{}) []string

Constants

const DefaultNamePrefix = "TRAEFIK_"

DefaultNamePrefix is the default prefix for environment variable names.

Functions

func Decode

func Decode(environ []string, prefix string, element interface{}) error

Decode decodes the given environment variables into the given element. The operation goes through four stages roughly summarized as: env vars -> map map -> tree of untyped nodes untyped nodes -> nodes augmented with metadata such as kind (inferred from element) "typed" nodes -> typed element.

func Encode

func Encode(element interface{}) ([]parser.Flat, error)

Encode encodes the configuration in element into the environment variables represented in the returned Flats. The operation goes through three stages roughly summarized as: typed configuration in element -> tree of untyped nodes untyped nodes -> nodes augmented with metadata such as kind (inferred from element) "typed" nodes -> environment variables with default values (determined by type/kind).

func FindPrefixedEnvVars

func FindPrefixedEnvVars(environ []string, prefix string, element interface{}) []string

FindPrefixedEnvVars finds prefixed environment variables.