env

Documentation

Index

• type Env
  • func New(env []string) (e *Env)
  • func NewFromOS() (e *Env)
  • func (e *Env) Changed() []VariableChange
  • func (e *Env) Environ() (vars []string)
  • func (e *Env) Get(name string) string
  • func (e *Env) IsInPath(path string) bool
  • 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 VariableChange

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) (e *Env)

New returns a new Env from an arbitrary list of variables

func NewFromOS

func NewFromOS() (e *Env)

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

func (*Env) Changed

func (e *Env) Changed() []VariableChange

Changed returns all changes made on the variables

func (*Env) Environ

func (e *Env) Environ() (vars []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) IsInPath

func (e *Env) IsInPath(path string) bool

IsInPath returns true if one path of $PATH is exactly equal to the path provided

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 VariableChange

type VariableChange struct {
	Name    string
	Value   string
	Deleted bool
}

A VariableChange represents the change made on a variable