utils

Documentation

Index

• func AddExtensionIfNotExist(filePath string, extension string) string
• func Clamp[T constraints.Ordered](v, low, high T) T
• func ClampCycle[T constraints.Ordered](v, low, high T) T
• func DownloadFile(filePath string, url string) error
• func EnsureFolderExistForFile(filePath string) error
• func ErrorHandler(f func(w http.ResponseWriter, r *http.Request) error) http.HandlerFunc
• func FileExists(filename string) bool
• func GetEnv(key, fallback string) string
• func GetRandomSample(s []string, n int) []string
• func GetUrlAsText(url string) (string, error)
• func InsertAt[T any](a []T, index int, value T) []T
• func LoadGob(filename string, data any) error
• func MakeMultipartPostRequest(url string, formData map[string]string, fileParamName, filePath string) (*http.Response, error)
• func Max[T constraints.Ordered](a, b T) T
• func MemUsageReport() string
• func Min[T constraints.Ordered](a, b T) T
• func MultiMax[T constraints.Ordered](args ...T) T
• func ReadFileFromTarGz(tarGzFile, extension string) (string, error)
• func ReadFileInZip(zipPath string, targetFileName string) (string, error)
• func ReadJSON(filename string, data any) error
• func Remove[T interface{}](s []T, i int) []T
• func RemoveExtension(filePath string) string
• func RemoveKeepOrder[T interface{}](slice []T, i int) []T
• func SaveGob(data any, filename string) error
• func SaveResponseBodyToFile(response *http.Response, filePath string) error
• func SetupConfigPath(rootPath string) error
• func SetupLogger(debug bool, log_file_name string) error
• func SetupTestConfig() error
• func TimeTrack(start time.Time, name string)
• func WriteJSON(filePath string, data any, prettyPrint bool, compress bool) error
• func WriteStringArrayToFile(strArray []string, filename string) error
• type GenericWebClient
  • func (c *GenericWebClient) GetUrl(endpoint string) string
• type Point
  • func (p *Point) SquaredDistanceFrom(other *Point) float64
• type Rect
  • func (rect *Rect) BBCenter() *Point
  • func (rect *Rect) Bottom() int
  • func (rect *Rect) Intersects(other *Rect) bool
  • func (rect *Rect) IsValid() bool
  • func (rect *Rect) Left() int
  • func (rect *Rect) Reset()
  • func (rect *Rect) Right() int
  • func (rect *Rect) Top() int

Functions

func AddExtensionIfNotExist

func AddExtensionIfNotExist(filePath string, extension string) string

func Clamp

func Clamp[T constraints.Ordered](v, low, high T) T

func ClampCycle

func ClampCycle[T constraints.Ordered](v, low, high T) T

func DownloadFile

func DownloadFile(filePath string, url string) error

func EnsureFolderExistForFile

func EnsureFolderExistForFile(filePath string) error

func ErrorHandler

func ErrorHandler(f func(w http.ResponseWriter, r *http.Request) error) http.HandlerFunc

func FileExists

func FileExists(filename string) bool

func GetEnv

func GetEnv(key, fallback string) string

func GetRandomSample

func GetRandomSample(s []string, n int) []string

func GetUrlAsText

func GetUrlAsText(url string) (string, error)

func InsertAt

func InsertAt[T any](a []T, index int, value T) []T

func LoadGob

func LoadGob(filename string, data any) error

func MakeMultipartPostRequest

func MakeMultipartPostRequest(url string, formData map[string]string, fileParamName, filePath string) (*http.Response, error)

func Max

func Max[T constraints.Ordered](a, b T) T

func MemUsageReport

func MemUsageReport() string

MemUsageReport outputs the current, total and OS memory being used. As well as the number of garage collection cycles completed.

func Min

func Min[T constraints.Ordered](a, b T) T

func MultiMax

func MultiMax[T constraints.Ordered](args ...T) T

https://stackoverflow.com/questions/73243943/how-to-write-a-generic-max-function

func ReadFileFromTarGz

func ReadFileFromTarGz(tarGzFile, extension string) (string, error)

Returns first found

func ReadFileInZip

func ReadFileInZip(zipPath string, targetFileName string) (string, error)

func ReadJSON

func ReadJSON(filename string, data any) error

func Remove

func Remove[T interface{}](s []T, i int) []T

order is not important

func RemoveExtension

func RemoveExtension(filePath string) string

func RemoveKeepOrder

func RemoveKeepOrder[T interface{}](slice []T, i int) []T

order is important

func SaveGob

func SaveGob(data any, filename string) error

func SaveResponseBodyToFile

func SaveResponseBodyToFile(response *http.Response, filePath string) error

func SetupConfigPath

func SetupConfigPath(rootPath string) error

func SetupLogger

func SetupLogger(debug bool, log_file_name string) error

func SetupTestConfig

func SetupTestConfig() error

func TimeTrack

func TimeTrack(start time.Time, name string)

func WriteJSON

func WriteJSON(filePath string, data any, prettyPrint bool, compress bool) error

func WriteStringArrayToFile

func WriteStringArrayToFile(strArray []string, filename string) error

Types

type GenericWebClient

type GenericWebClient struct {
	Hostname string
	Port     int
}

func (*GenericWebClient) GetUrl

func (c *GenericWebClient) GetUrl(endpoint string) string

type Point

type Point struct {
	X, Y int
}

func (*Point) SquaredDistanceFrom

func (p *Point) SquaredDistanceFrom(other *Point) float64

type Rect

type Rect struct {
	X, Y, W, H int
}

func (*Rect) BBCenter

func (rect *Rect) BBCenter() *Point

func (*Rect) Bottom

func (rect *Rect) Bottom() int

func (*Rect) Intersects

func (rect *Rect) Intersects(other *Rect) bool

func (*Rect) IsValid

func (rect *Rect) IsValid() bool

func (*Rect) Left

func (rect *Rect) Left() int

func (*Rect) Reset

func (rect *Rect) Reset()

func (*Rect) Right

func (rect *Rect) Right() int

func (*Rect) Top

func (rect *Rect) Top() int