envparse

Documentation

Overview

Package envparse provides a way to parse environment variables from a struct

Index

• Variables
• type Config
  • func (c Config) GatherEnvInfo(prefix string, spec interface{}) ([]varInfo, error)

Variables

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

ErrInvalidSpecification indicates that a specification is of the wrong type.

Types

type Config

type Config struct {
	// FieldTagName is the name of the struct tag to use for the field name
	FieldTagName string
	// Skipper is the value of the tag to skip parsing of the field
	Skipper string
}

func (Config) GatherEnvInfo

func (c Config) GatherEnvInfo(prefix string, spec interface{}) ([]varInfo, error)

GatherEnvInfo gathers information about the specified struct, including defaults and environment variable names.