environment

Documentation

Index

• Variables
• type Check
• type Key
• type Pair
  • func NewPair(environ string) Pair
• type Value
• type Values
  • func Current() Values
  • func New(environ ...string) Values
  • func (v Values) Add(pair Pair)
• type ValuesSupplier
• type VersionResolver
  • func NewVersionResolver(options ...VersionResolverOption) VersionResolver
  • func (e VersionResolver) IsLatest(_ string) (bool, error)
  • func (e VersionResolver) Version() string
• type VersionResolverOption
  • func WithValuesSupplier(vs ValuesSupplier) VersionResolverOption

Variables

var ErrNotSupported = errors.New("not supported")

ErrNotSupported when operation is not supported.

Types

type Check

type Check Pair

Check is used to verify environment values.

type Key

type Key string

Key is an environment key.

type Pair

type Pair struct {
	Key
	Value
}

Pair holds a pair of environment key and value.

func NewPair

func NewPair(environ string) Pair

NewPair creates a pair from os.Environ style string.

type Value

type Value string

Value is an environment value.

type Values

type Values map[Key]Value

Values holds environment values together with their keys.

func Current

func Current() Values

Current returns current environment values, from os.Environ method.

func New

func New(environ ...string) Values

New returns an environmental values bases on input compatible with the os.Environ function.

func (Values) Add

func (v Values) Add(pair Pair)

Add a pair to environment values.

type ValuesSupplier

type ValuesSupplier func() Values

ValuesSupplier is a func that supplies environmental values.

type VersionResolver

type VersionResolver struct {
	VersionKey   Key
	IsApplicable []Check
	ValuesSupplier
}

VersionResolver is used to resolve version information solely on environment variables.

func NewVersionResolver

func NewVersionResolver(options ...VersionResolverOption) VersionResolver

NewVersionResolver creates a VersionResolver using options.

func (VersionResolver) IsLatest

func (e VersionResolver) IsLatest(_ string) (bool, error)

func (VersionResolver) Version

func (e VersionResolver) Version() string

type VersionResolverOption

type VersionResolverOption func(*VersionResolver)

VersionResolverOption is used to customize creation of VersionResolver.

func WithValuesSupplier

func WithValuesSupplier(vs ValuesSupplier) VersionResolverOption

WithValuesSupplier allows to set the values supplier.