env

Documentation

Overview

Package env provides methods for working with environment variables

Index

• func Which(name string) string
• type Env
  • func Get() Env
  • func (e Env) GetF(name string) float64
  • func (e Env) GetI(name string) int
  • func (e Env) GetS(name string) string
  • func (e Env) Path() []string
• type Variable
  • func Var(name string) *Variable
  • func (v *Variable) Get() string
  • func (v *Variable) Is(value string) bool
  • func (v *Variable) Reset() *Variable
  • func (v *Variable) String() string

Examples

• Get
• Var
• Which

Functions

func Which

func Which(name string) string

Which find full path to some app

Example

echoPath := Which("echo")

fmt.Printf("Full path to echo binary is %s\n", echoPath)

Types

type Env

type Env map[string]string

Env is map with environment values

func Get

func Get() Env

Get return key-value map with environment values

Example

env := Get()

// Print PATH environment variable
fmt.Println(env["PATH"])

// Path return PATH variable as slice
for i, p := range env.Path() {
	fmt.Printf("%d %s\n", i, p)
}

// You can use getters for different value formats
fmt.Printf("Integer value %s = %d\n", "INT_VALUE", env.GetI("INT_VALUE"))
fmt.Printf("Float value %s = %g\n", "FLOAT_VALUE", env.GetF("FLOAT_VALUE"))
fmt.Printf("String value %s = %s\n", "STR_VALUE", env.GetS("STR_VALUE"))

func (Env) GetF

func (e Env) GetF(name string) float64

GetF return environment variable value as float

func (Env) GetI

func (e Env) GetI(name string) int

GetI return environment variable value as int

func (Env) GetS

func (e Env) GetS(name string) string

GetS return environment variable value as string

func (Env) Path

func (e Env) Path() []string

Path return path as string slice

type Variable

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

Variable is environment variable for lazy reading

func Var

func Var(name string) *Variable

Var creates new environment variable struct

Example

v := Var("PATH")

fmt.Println(v.Get())

func (*Variable) Get

func (v *Variable) Get() string

Get returns environment variable value

func (*Variable) Is

func (v *Variable) Is(value string) bool

Is returns true if environment variable value is equal to given one

func (*Variable) Reset

func (v *Variable) Reset() *Variable

Reset resets reading state of variable

func (*Variable) String

func (v *Variable) String() string

String returns environment variable value as string