utils

Documentation

Overview

Package utils provides general utility methods. The '*Ptr' functions were borrowed/inspired by the kubernetes go-client.

Index

• func BoolPtr(b bool) *bool
• func BoxStaticFile(boxName string, path ...string) *packr.Box
• func CallerFileLine() (string, int)
• func CallerName(up int) string
• func CallerPath(up int) string
• func Int64Ptr(i int64) *int64
• func PanicPrecaution() error
• func ReadStaticFile(path ...string) ([]byte, error)
• func ReformatError(e string, v ...interface{}) error
• func ReplaceBytesValue(b []byte, old string, new string) []byte
• func StringPtr(s string) *string

Functions

func BoolPtr

func BoolPtr(b bool) *bool

BoolPtr returns a pointer to a bool

func BoxStaticFile

func BoxStaticFile(boxName string, path ...string) *packr.Box

func CallerFileLine

func CallerFileLine() (string, int)

func CallerName

func CallerName(up int) string

CallerName retrieves the name of the function prior to the location it is called

func CallerPath

func CallerPath(up int) string

func Int64Ptr

func Int64Ptr(i int64) *int64

Int64Ptr returns a pointer to an int64

func PanicPrecaution

func PanicPrecaution() error

Placeholder error in case function panics

func ReadStaticFile

func ReadStaticFile(path ...string) ([]byte, error)

func ReformatError

func ReformatError(e string, v ...interface{}) error

utils.ReformatError prefixes the error string ready for logging and/or output

func ReplaceBytesValue

func ReplaceBytesValue(b []byte, old string, new string) []byte

func StringPtr

func StringPtr(s string) *string

StringPtr returns a pointer to the passed string.