env

Documentation

Index

• Constants
• func GetPid() int
• func IsHookEnv() bool
• type Envs
• type Manager
  • func NewEnvManager(vfConfigPath string) (Manager, error)
• type PathFrom
• type Paths
  • func NewPaths(from PathFrom) *Paths
  • func (p *Paths) Merge(other *Paths) *Paths
  • func (p *Paths) String() string
  • func (p *Paths) ToBinPaths() (*Paths, error)
• type Vars

Constants

const (
	HookFlag = "__VFOX_SHELL"
	PidFlag  = "__VFOX_PID"
)

Functions

func GetPid

func GetPid() int

func IsHookEnv

func IsHookEnv() bool

Types

type Envs

type Envs struct {
	Variables Vars
	BinPaths  *Paths
	Paths     *Paths
}

Envs is a struct that contains environment variables and PATH.

type Manager

type Manager interface {
	Flush() error
	Load(envs *Envs) error
	Get(key string) (string, bool)
	Remove(envs *Envs) error
	io.Closer
}

func NewEnvManager

func NewEnvManager(vfConfigPath string) (Manager, error)

type PathFrom

type PathFrom int

const (
	EmptyPaths PathFrom = iota
	OsPaths
)

type Paths

type Paths struct {
	*util.SortedSet[string]
}

Paths is a slice of PATH.

func NewPaths

func NewPaths(from PathFrom) *Paths

NewPaths returns a new Paths. from is the source of the paths. If from is OsPaths, it returns the paths from the environment variable PATH. If from is PreviousPaths, it returns the paths from the environment variable __VFOX_PREVIOUS_PATHS If from is neither OsPaths nor PreviousPaths, it returns an empty Paths.

func (*Paths) Merge

func (p *Paths) Merge(other *Paths) *Paths

func (*Paths) String

func (p *Paths) String() string

func (*Paths) ToBinPaths

func (p *Paths) ToBinPaths() (*Paths, error)

ToBinPaths returns a BinPaths from Paths which contains only executable files.

type Vars

type Vars map[string]*string

Vars is a map of environment variables