package envconfig

import "github.com/kelseyhightower/envconfig"

Package envconfig implements decoding of environment variables based on a user defined specification. A typical use is using environment variables for configuration settings.

Index ¶

• Constants
• Variables
• func CheckDisallowed(prefix string, spec interface{}) error
• func MustProcess(prefix string, spec interface{})
• func Process(prefix string, spec interface{}) error
• func Usage(prefix string, spec interface{}) error
• func Usagef(prefix string, spec interface{}, out io.Writer, format string) error
• func Usaget(prefix string, spec interface{}, out io.Writer, tmpl *template.Template) error
• type Decoder
• type ParseError
• func (e *ParseError) Error() string
• type Setter

Constants ¶

const (
	DefaultListFormat = "" /* 284 byte string literal not displayed */

	DefaultTableFormat = "" /* 258 byte string literal not displayed */

)

Variables ¶

var ErrInvalidSpecification = errors.New("specification must be a struct pointer")

ErrInvalidSpecification indicates that a specification is of the wrong type.

Functions ¶

func CheckDisallowed ¶

func CheckDisallowed(prefix string, spec interface{}) error

CheckDisallowed checks that no environment variables with the prefix are set that we don't know how or want to parse. This is likely only meaningful with a non-empty prefix.

func MustProcess ¶

func MustProcess(prefix string, spec interface{})

MustProcess is the same as Process but panics if an error occurs

func Process ¶

func Process(prefix string, spec interface{}) error

Process populates the specified struct based on environment variables

func Usage ¶

func Usage(prefix string, spec interface{}) error

Usage writes usage information to stdout using the default header and table format

func Usagef ¶

func Usagef(prefix string, spec interface{}, out io.Writer, format string) error

Usagef writes usage information to the specified io.Writer using the specifed template specification

func Usaget ¶

func Usaget(prefix string, spec interface{}, out io.Writer, tmpl *template.Template) error

Usaget writes usage information to the specified io.Writer using the specified template

Types ¶

type Decoder ¶

type Decoder interface {
	Decode(value string) error
}

Decoder has the same semantics as Setter, but takes higher precedence. It is provided for historical compatibility.

type ParseError ¶

type ParseError struct {
	KeyName   string
	FieldName string
	TypeName  string
	Value     string
	Err       error
}

A ParseError occurs when an environment variable cannot be converted to the type required by a struct field during assignment.

func (*ParseError) Error ¶

func (e *ParseError) Error() string

type Setter ¶

type Setter interface {
	Set(value string) error
}

Setter is implemented by types can self-deserialize values. Any type that implements flag.Value also implements Setter.

Source Files ¶

doc.go env_os.go envconfig.go usage.go