env

Documentation

Index

• Variables
• type Env
  • func NewBuildEnv(environ []string) *Env
  • func NewLaunchEnv(environ []string, processDir string, lifecycleDir string) *Env
  • func (p *Env) AddEnvDir(envDir string) error
  • func (p *Env) AddRootDir(baseDir string) error
  • func (p *Env) Get(k string) string
  • func (p *Env) List() []string
  • func (p *Env) WithPlatform(platformDir string) (out []string, err error)
• type Vars
  • func NewVars(vars map[string]string, ignoreCase bool) *Vars
  • func (s *Vars) Get(key string) string
  • func (s *Vars) List() []string
  • func (s *Vars) Set(key, value string)

Variables

var BuildEnvIncludelist = []string{
	"CNB_STACK_ID",
	"HOSTNAME",
	"HOME",
	"HTTPS_PROXY",
	"https_proxy",
	"HTTP_PROXY",
	"http_proxy",
	"NO_PROXY",
	"no_proxy",
}

var LaunchEnvExcludelist = []string{
	"CNB_LAYERS_DIR",
	"CNB_APP_DIR",
	"CNB_PROCESS_TYPE",
	"CNB_PLATFORM_API",
	"CNB_DEPRECATION_MODE",
}

var POSIXBuildEnv = map[string][]string{
	"bin": {
		"PATH",
	},
	"lib": {
		"LD_LIBRARY_PATH",
		"LIBRARY_PATH",
	},
	"include": {
		"CPATH",
	},
	"pkgconfig": {
		"PKG_CONFIG_PATH",
	},
}

var POSIXLaunchEnv = map[string][]string{
	"bin": {"PATH"},
	"lib": {"LD_LIBRARY_PATH"},
}

Types

type Env

type Env struct {
	RootDirMap map[string][]string
	Vars       *Vars
}

func NewBuildEnv

func NewBuildEnv(environ []string) *Env

func NewLaunchEnv

func NewLaunchEnv(environ []string, processDir string, lifecycleDir string) *Env

NewLaunchEnv returns an Env for process launch from the given environ.

Keys in the LaunchEnvExcludelist shall be removed. processDir will be removed from the beginning of PATH if present.

func (*Env) AddEnvDir

func (p *Env) AddEnvDir(envDir string) error

func (*Env) AddRootDir

func (p *Env) AddRootDir(baseDir string) error

func (*Env) Get

func (p *Env) Get(k string) string

Get returns the value for the given key

func (*Env) List

func (p *Env) List() []string

func (*Env) WithPlatform

func (p *Env) WithPlatform(platformDir string) (out []string, err error)

type Vars

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

func NewVars

func NewVars(vars map[string]string, ignoreCase bool) *Vars

func (*Vars) Get

func (s *Vars) Get(key string) string

func (*Vars) List

func (s *Vars) List() []string

func (*Vars) Set

func (s *Vars) Set(key, value string)