utils

Documentation

Overview

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

Index

• func AuditPlaceholders() (strings.Builder, interface{}, error)
• func BoolPtr(b bool) *bool
• func CallerFileLine() (string, int)
• func CallerName(up int) string
• func CallerPath(up int) string
• func FindString(slice []string, val string) (int, bool)
• func Int64Ptr(i int64) *int64
• func RandomString(n int) string
• func ReadStaticFile(path ...string) ([]byte, error)
• func ReformatError(e string, v ...interface{}) error
• func ReplaceBytesMultipleValues(b []byte, replacer *strings.Replacer) []byte
• func ReplaceBytesValue(b []byte, old string, new string) []byte
• func StringPtr(s string) *string
• func WriteAllowed(path string, overwrite bool) bool

Functions

func AuditPlaceholders

func AuditPlaceholders() (strings.Builder, interface{}, error)

AuditPlaceholders creates empty objects to reduce code repetition when auditing probe steps

func BoolPtr

func BoolPtr(b bool) *bool

BoolPtr returns a pointer to a bool

func CallerFileLine

func CallerFileLine() (string, int)

CallerFileLine returns file name and line of invoker Similar to CallerName(1), but with file and line returned

func CallerName

func CallerName(up int) string

CallerName retrieves the name of the function prior to the location it is called If using CallerName(0), the current function's name will be returned If using CallerName(1), the current function's parent name will be returned If using CallerName(2), the current function's parent's parent name will be returned

func CallerPath

func CallerPath(up int) string

CallerPath checks the goroutine's stack of function invocation and returns the following: For up=0, return full caller path for caller function For up=1, returns full caller path for caller of caller

func FindString

func FindString(slice []string, val string) (int, bool)

FindString searches a []string for a specific value. If found, returns the index of first occurrence, and True. If not found, returns -1 and False.

func Int64Ptr

func Int64Ptr(i int64) *int64

Int64Ptr returns a pointer to an int64

func RandomString

func RandomString(n int) string

RandomString generates a pseudo-random number of characters of length n

func ReadStaticFile

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

ReadStaticFile returns the bytes for a given static file Path:

In most cases it will be ReadStaticFile(assetDir, fileName).
It could also be used as ReadStaticFile(assetDir, subfolder, filename)

func ReformatError

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

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

func ReplaceBytesMultipleValues

func ReplaceBytesMultipleValues(b []byte, replacer *strings.Replacer) []byte

ReplaceBytesMultipleValues replaces multiple substring with a new value for a given string in bytes

func ReplaceBytesValue

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

ReplaceBytesValue replaces a substring with a new value for a given string in bytes

func StringPtr

func StringPtr(s string) *string

StringPtr returns a pointer to the passed string.

func WriteAllowed

func WriteAllowed(path string, overwrite bool) bool

WriteAllowed determines whether a given filepath can be written, considering both permissions and overwrite flag