getenv

Documentation

Index

• Constants
• func GetEnv(key string) (string, error)
• func Init() error
• func InitFromFile(filename string) error
• type Error
  • func (err *Error) Error() string

Constants

const (

	// NoValue is used if requested ENV var doesn't exist
	NoValue = ""
	// CwdFailureError signals that the current working directory can not be determined
	CwdFailureError = 1
	// CantAccessEnvFileError signals that the env file exists but can not be accessed
	CantAccessEnvFileError = 2
	// NoEnvFileError signals that no env file exists in any of the parent directories
	NoEnvFileError = 3
	// CantLoadEnvFileError signals that the env file exists and can be accessed but not parsed and exported
	CantLoadEnvFileError = 4
	// NoSuchEnvVarError signals that the requested ENV var doesn't exist
	NoSuchEnvVarError = 5
)

Functions

func GetEnv

func GetEnv(key string) (string, error)

GetEnv returns requested ENV variable.

func Init

func Init() error

Init looks for ENV file and extracts ENV variables from it.

func InitFromFile

func InitFromFile(filename string) error

InitFromFile looks for custom ENV file and extracts ENV variables from it.

Types

type Error

type Error struct {
	Code int
	Err  error
}

Error is a custom error type which provides useful error codes

func (*Error) Error

func (err *Error) Error() string