goenv

README

goenv

Golang library for managing configuration data from environment variables -- Just do simple things well.

Documentation

Index

• Variables
• func ImplementsBinaryUnmarshaler(relectType reflect.Type) bool
• func ImplementsDecoder(relectType reflect.Type) bool
• func ImplementsSetter(relectType reflect.Type) bool
• func ImplementsTextUnmarshaler(relectType reflect.Type) bool
• func NewErrRequiredEnvKeyForField(envKey, fieldTypeName string) error
• func Unmarshal(config interface{}) error
• type Decoder
• type ErrRequiredEnvKeyForField
  • func (e *ErrRequiredEnvKeyForField) Error() string
• type Setter

Variables

var (
	ErrConfigurationMustBeAStructPointer error = errors.New("configuration must be a struct pointer")
)

Functions

func ImplementsBinaryUnmarshaler

func ImplementsBinaryUnmarshaler(relectType reflect.Type) bool

func ImplementsDecoder

func ImplementsDecoder(relectType reflect.Type) bool

func ImplementsSetter

func ImplementsSetter(relectType reflect.Type) bool

func ImplementsTextUnmarshaler

func ImplementsTextUnmarshaler(relectType reflect.Type) bool

func NewErrRequiredEnvKeyForField

func NewErrRequiredEnvKeyForField(envKey, fieldTypeName string) error

func Unmarshal

func Unmarshal(config interface{}) error

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 ErrRequiredEnvKeyForField

type ErrRequiredEnvKeyForField struct {
	// contains filtered or unexported fields
}

func (*ErrRequiredEnvKeyForField) Error

func (e *ErrRequiredEnvKeyForField) 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.