env

Documentation

Index

• type Env
  • func New(env []string) *Env
  • func NewFromOS() *Env
  • func (e *Env) Environ() []string
  • func (e *Env) Get(name string) string
  • func (e *Env) Has(name string) bool
  • func (e *Env) Mutations() []VariableMutation
  • func (e *Env) PrependToPath(path string)
  • func (e *Env) RemoveFromPath(substring string)
  • func (e *Env) Set(name string, value string)
  • func (e *Env) Unset(name string)
• type VariableMutation
  • func (m VariableMutation) DiffString() string
• type Variables
  • func NewVariables(environ []string) Variables

Types

type Env

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

An Env provides a simple interface to manipulate environment variables

func New

func New(env []string) *Env

New returns a new Env from an arbitrary list of variables

func NewFromOS

func NewFromOS() *Env

NewFromOS returns a new Env with variables from os.Environ()

func (*Env) Environ

func (e *Env) Environ() []string

Environ returns all variable as os.Environ() would

func (*Env) Get

func (e *Env) Get(name string) string

Get returns the value of a variable (defaults to empty string)

func (*Env) Has

func (e *Env) Has(name string) bool

Has returns whether the variable exists

func (*Env) Mutations

func (e *Env) Mutations() []VariableMutation

Mutations returns a list of variable mutations (previous and current value)

func (*Env) PrependToPath

func (e *Env) PrependToPath(path string)

PrependToPath inserts a new path at the beginning of the PATH variable

func (*Env) RemoveFromPath

func (e *Env) RemoveFromPath(substring string)

RemoveFromPath removes all path entries matching a substring

func (*Env) Set

func (e *Env) Set(name string, value string)

Set adds or changes a variable

func (*Env) Unset

func (e *Env) Unset(name string)

Unset removes a variable if it exists

type VariableMutation

type VariableMutation struct {
	Name     string
	Previous *variable
	Current  *variable
}

VariableMutation represents the change made on a variable

func (VariableMutation) DiffString

func (m VariableMutation) DiffString() string

DiffString returns a representation of the mutation as a diff

type Variables

type Variables map[string]*variable

func NewVariables

func NewVariables(environ []string) Variables