env

Documentation

Index

• type Config
• type Env
  • func New(config Config) (*Env, error)
  • func (e *Env) AddEnvVars(envvars ...string)
  • func (e *Env) Close()
  • func (e *Env) GetEnvVar(name string) string
  • func (e *Env) GetEnvVars() []string
  • func (e *Env) GetPath() string
  • func (e *Env) Link(source string, linkFileName string) error
  • func (e *Env) Run(cmdString string) (string, error)
  • func (e *Env) SetWorkDir(workDir string)
• type Path

Types

type Config

type Config struct {
	Path    *Path
	EnvVars []string
	WorkDir string
}

Config represents the an environment configuration

type Env

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

Env represents the Env type

func New

func New(config Config) (*Env, error)

New configures a new environment

func (*Env) AddEnvVars

func (e *Env) AddEnvVars(envvars ...string)

AddEnvVars adds a list of environment variables

func (*Env) Close

func (e *Env) Close()

Close cleans up resources created by the env

func (*Env) GetEnvVar

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

GetEnvVar returns the value of the given environment variable in the current environment

func (*Env) GetEnvVars

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

GetEnvVars provides all the environment variables (including the generated PATH)

func (*Env) GetPath

func (e *Env) GetPath() string

GetPath returns the current PATH directory

func (*Env) Link

func (e *Env) Link(source string, linkFileName string) error

Link creates a symlink in the environment path to the source file if linkName is empty, will use the same filename

func (*Env) Run

func (e *Env) Run(cmdString string) (string, error)

Run runs a shell command in the environment

func (*Env) SetWorkDir

func (e *Env) SetWorkDir(workDir string)

SetWorkDir sets the current working directory

type Path

type Path struct {
	Directory     string
	Prefix        string
	RemoveOnClose bool
}

Path represents the environment's PATH configuration