util

Documentation

Index

• Variables
• func GetEnvBoolDefault(envVar string, defaultValue bool) bool
• func GetEnvDefault(envVar, defaultValue string) string
• func InSlice(s string, slice []string) bool
• func IsTextFile(file *os.File) error
• func IsTextFileFromFilename(filename string) error
• func MarkdownCodify(s string) string

Variables

var (
	// ErrFileEmpty is an error to signify the file is empty
	ErrFileEmpty = errors.New("file is empty")
	// ErrFileNotText is an error to signify the file type is not a text file that can be read
	ErrFileNotText = errors.New("file is not a text file")
	// ErrIsDir is an error to signify a directory
	ErrIsDir = errors.New("file is a directory")
)

Functions

func GetEnvBoolDefault

func GetEnvBoolDefault(envVar string, defaultValue bool) bool

GetEnvBoolDefault is similar to GetEnvDefault, but with booleans instead of strings

func GetEnvDefault

func GetEnvDefault(envVar, defaultValue string) string

GetEnvDefault returns the value of the environment variable, or a default value if the environment variable is not defined or is an empty string

func InSlice

func InSlice(s string, slice []string) bool

InSlice returns true if a string is found in the slice

func IsTextFile

func IsTextFile(file *os.File) error

IsTextFile returns an error if the file is not of content-type 'text/*'

func IsTextFileFromFilename

func IsTextFileFromFilename(filename string) error

IsTextFileFromFilename returns an error if the filename is not of content-type 'text/*'

func MarkdownCodify

func MarkdownCodify(s string) string

MarkdownCodify returns a markdown code string https://www.markdownguide.org/basic-syntax/#code