environ

Documentation

Index

• type Environ
  • func (e *Environ) IsSet(key string) bool
  • func (e *Environ) Load(s store.Store, service string, collisions *[]string) error
  • func (e *Environ) LoadNoPaths(s store.Store, service string, collisions *[]string) error
  • func (e *Environ) LoadStrict(s store.Store, valueExpected string, pristine bool, services ...string) error
  • func (e *Environ) LoadStrictNoPaths(s store.Store, valueExpected string, pristine bool, services ...string) error
  • func (e *Environ) Map() map[string]string
  • func (e *Environ) Set(key, val string)
  • func (e *Environ) Unset(key string)
• type ErrExpectedKeyUnnormalized
  • func (e ErrExpectedKeyUnnormalized) Error() string
• type ErrStoreMissingKey
  • func (e ErrStoreMissingKey) Error() string
• type ErrStoreUnexpectedValue
  • func (e ErrStoreUnexpectedValue) Error() string

Types

type Environ

type Environ []string

environ is a slice of strings representing the environment, in the form "key=value".

func (*Environ) IsSet

func (e *Environ) IsSet(key string) bool

IsSet returns whether or not a key is currently set in the environ

func (*Environ) Load

func (e *Environ) Load(s store.Store, service string, collisions *[]string) error

Load loads environment variables into e from s given a service collisions will be populated with any keys that get overwritten

func (*Environ) LoadNoPaths

func (e *Environ) LoadNoPaths(s store.Store, service string, collisions *[]string) error

LoadNoPaths is identical to Load, but uses v1-style "."-separated paths

Deprecated like all noPaths functionality

func (*Environ) LoadStrict

func (e *Environ) LoadStrict(s store.Store, valueExpected string, pristine bool, services ...string) error

LoadStrict loads all services from s in strict mode: env vars in e with value equal to valueExpected are the only ones substituted. If there are any env vars in s that are also in e, but don't have their value set to valueExpected, this is an error.

func (*Environ) LoadStrictNoPaths

func (e *Environ) LoadStrictNoPaths(s store.Store, valueExpected string, pristine bool, services ...string) error

LoadNoPathsStrict is identical to LoadStrict, but uses v1-style "."-separated paths

Deprecated like all noPaths functionality

func (*Environ) Map

func (e *Environ) Map() map[string]string

Map squashes the list-like environ, taking the latter value when there are collisions, like a shell would. Invalid items (e.g., missing `=`) are dropped

func (*Environ) Set

func (e *Environ) Set(key, val string)

Set adds an environment variable, replacing any existing ones of the same key

func (*Environ) Unset

func (e *Environ) Unset(key string)

Unset an environment variable by key

type ErrExpectedKeyUnnormalized

type ErrExpectedKeyUnnormalized struct {
	Key           string
	ValueExpected string
}

func (ErrExpectedKeyUnnormalized) Error

func (e ErrExpectedKeyUnnormalized) Error() string

type ErrStoreMissingKey

type ErrStoreMissingKey struct {
	// env-style key
	Key           string
	ValueExpected string
}

func (ErrStoreMissingKey) Error

func (e ErrStoreMissingKey) Error() string

type ErrStoreUnexpectedValue

type ErrStoreUnexpectedValue struct {
	// store-style key
	Key           string
	ValueExpected string
	ValueActual   string
}

func (ErrStoreUnexpectedValue) Error

func (e ErrStoreUnexpectedValue) Error() string