env

package

v0.6.10 Latest Latest Go to latest Published: May 20, 2025 License: Apache-2.0 Imports: 8 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/version-fox/vfox

Links

Open Source Insights

Documentation ¶

Rendered for

Index ¶

Constants
func GetPid() int
func GetVfoxCache() string
func GetVfoxHome() string
func GetVfoxPlugin() string
func GetVfoxTemp() string
func IsHookEnv() bool
type Envs
type Manager
- func NewEnvManager(vfConfigPath string) (Manager, error)
type PathFrom
type Paths
- func NewPaths(from PathFrom) *Paths
type Vars

Constants ¶

View Source

const (
	HomeFromEnv   = "VFOX_HOME"
	PluginFromEnv = "VFOX_PLUGIN"
	CacheFromEnv  = "VFOX_CACHE"
	TempFromEnv   = "VFOX_TEMP"

	HookFlag = "__VFOX_SHELL"
	PidFlag  = "__VFOX_PID"
)

View Source

const Newline = "\n"

View Source

const PathVarName = "PATH"

Variables ¶

This section is empty.

Functions ¶

func GetPid ¶ added in v0.2.5

func GetPid() int

func GetVfoxCache ¶ added in v0.6.6

func GetVfoxCache() string

func GetVfoxHome ¶ added in v0.6.6

func GetVfoxHome() string

func GetVfoxPlugin ¶ added in v0.6.6

func GetVfoxPlugin() string

func GetVfoxTemp ¶ added in v0.6.6

func GetVfoxTemp() string

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 ¶ added in v0.3.0

type PathFrom int

const (
	EmptyPaths PathFrom = iota
	OsPaths
)

type Paths ¶ added in v0.2.5

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

Paths is a slice of PATH.

func NewPaths ¶ added in v0.3.0

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.

func (*Paths) Merge ¶ added in v0.3.0

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

func (*Paths) String ¶ added in v0.3.0

func (p *Paths) String() string

func (*Paths) ToBinPaths ¶ added in v0.5.0

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

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

type Vars ¶ added in v0.2.5

type Vars map[string]*string

Vars is a map of environment variables

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL