osext

Documentation

Overview

Package osext contains extensions to the standard library package "os".

Index

• func GetenvBool(key string) bool
• func GetenvOrDefault(key, defaultValue string) string
• func MustGetenv(key string) string
• func NeedGetenv(key string) (string, error)
• type MissingEnvError
  • func (e MissingEnvError) Error() string

Functions

func GetenvBool

func GetenvBool(key string) bool

GetenvBool returns true if and only if the environment variable with the given key exists and contains a string that strconv.ParseBool() recognizes as true. Non-existent or malformed values will be coerced into "false".

This method is commonly used for optional behavior flags, e.g. to activate debug logging.

func GetenvOrDefault

func GetenvOrDefault(key, defaultValue string) string

GetenvOrDefault returns os.Getenv(key), except that if the environment variable is not set, the given default value will be returned instead.

func MustGetenv

func MustGetenv(key string) string

NeedGetenv returns os.Getenv(key), or panics if the environment variable is not set.

func NeedGetenv

func NeedGetenv(key string) (string, error)

NeedGetenv returns os.Getenv(key), or an error if the environment variable is not set.

Types

type MissingEnvError

type MissingEnvError struct {
	Key string
}

MissingEnvError is an error that occurs when an required environment variable was not present.

func (MissingEnvError) Error

func (e MissingEnvError) Error() string

Error implements the builtin/error interface.