env

Documentation

Index

• func EmptyAttributeError(attr string) error
• func ParseSplitError(env string) error
• type Config
  • func New() *Config
  • func (s *Config) Body() Envs
  • func (s *Config) FromOsEnviron() *Config
  • func (s *Config) Key() string
  • func (s *Config) SetBodyMap(env common.BodyMap) *Config
  • func (s *Config) SetEnv(env Envs) *Config
  • func (s *Config) ToBodyMap() (common.BodyMap, error)
  • func (s *Config) ToOsEnviron() (Envs, error)
• type Envs

Functions

func EmptyAttributeError

func EmptyAttributeError(attr string) error

EmptyAttributeError is for when a required attribute is empty.

func ParseSplitError

func ParseSplitError(env string) error

ParseSplitError is for when failing to parse a env-line.

Types

type Config

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

Config contains the given "path", "extn" and "body" of a config, as well as the parsed config --> KV map.

func New

func New() *Config

New object.

func (*Config) Body

func (s *Config) Body() Envs

Body returns s.path as a key, for use by the configs package.

func (*Config) FromOsEnviron

func (s *Config) FromOsEnviron() *Config

FromOsEnviron sets s.env to the current os.Environ.

func (*Config) Key

func (s *Config) Key() string

Key returns a sort key, for use by the configs package. This makes little sense for os.Environ, so we always return "".

func (*Config) SetBodyMap

func (s *Config) SetBodyMap(env common.BodyMap) *Config

SetBodyMap creates a new env.Configs object, with the contents of a Maps object added to its EnvMaps.

func (*Config) SetEnv

func (s *Config) SetEnv(env Envs) *Config

SetEnv sets s.env struct, with the given env.

func (*Config) ToBodyMap

func (s *Config) ToBodyMap() (common.BodyMap, error)

ToBodyMap returns the parsed map, for use by the configs package.

func (*Config) ToOsEnviron

func (s *Config) ToOsEnviron() (Envs, error)

ToOsEnviron returns the config, converted to a list of "K=V" lines

type Envs

type Envs []string

Envs is the type of an os.Environ-provided env-list.