env

package
v3.6.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 13, 2025 License: AGPL-3.0 Imports: 18 Imported by: 12

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Environ

func Environ() []string

Environ returns a copy of strings representing the environment, in the form "key=value".

func Get

func Get(key, defaultValue string) string

Get returns the value of the environment variable named by key. If the variable is unset or set to an empty string, defaultValue is returned.

func GetDuration

func GetDuration(key string, defaultValue time.Duration) (time.Duration, error)

GetDuration returns a parsed time.Duration if found in the environment value, returns the default value duration otherwise.

func GetInt

func GetInt(key string, defaultValue int) (int, error)

GetInt returns an integer if found in the environment and returns the default value otherwise.

func IsSet

func IsSet(key string) bool

IsSet returns if the given env key is set. remember ENV must be a non-empty. All empty values are considered unset.

func List

func List(prefix string) (envs []string)

List all envs with a given prefix.

func LockSetEnv

func LockSetEnv() func()

LockSetEnv locks modifications to environment. Call returned function to unlock.

func LookupEnv

func LookupEnv(key string) (string, string, string, error)

LookupEnv retrieves the value of the environment variable named by `key`.

If the value of the variable starts with "env://" or "env+tls://" it is fetched from the referenced remote server. The fetched value is cached in a separate environment variable prefixed with an underscore for subsequent lookups should the remote server be unreachable. When fetching from a remote server the username and password used are also returned.

For regular environment variables the value is returned as-is with empty credentials.

func RegisterGlobalCAs

func RegisterGlobalCAs(CAs *x509.CertPool)

RegisterGlobalCAs register the global root CAs

func SetEnvOff

func SetEnvOff()

SetEnvOff - turns off env lookup A global lock above this MUST ensure that

func SetEnvOn

func SetEnvOn()

SetEnvOn - turns on env lookup

Types

This section is empty.

Jump to

Keyboard shortcuts

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