golib

README

golib

This is just some common functionality I use across several projects. No guarantees that anything will work. You probably shouldn't use the repo directly, just copy anything you want from it.

Documentation

Overview

Package util provides general utility functions shared by the other modules

Index

• func BToMb(b uint64) uint64
• func CreateGUID() string
• func EstSpeed(startTime int64, lastTime int64, bytesSent uint64) uint64
• func Exists(path string) bool
• func FindFile(p string, minRootDir string) string
• func GenRandomBytes(size int) (blk []byte, err error)
• func GetFileSize(fileName string) (int64, error)
• func HumanBytesString(s uint64) string
• func HumanIBytesString(s uint64) string
• func IsDir(path string) bool
• func MinInt(a, b int) int
• func RandomString(n int) string
• func RenderMD(md string) string
• func StringToBool(s string, def bool) bool
• func StringToFloat64(s string, def float64) float64
• func StringToInt16(s string, def int16) int16
• func StringToTime(s string) time.Time
• func StringToUInt(s string, def int) int
• func StringToUInt16(s string, def uint16) uint16
• func StringToUInt32(s string, def uint32) uint32
• func StringToUInt64(s string, def uint64) uint64
• func TimeToString(t time.Time) string
• func ToTable(rows [][]string, opts TableOpts) string
• func UMax(a, b uint) uint
• func UMax16(a, b uint16) uint16
• func UMax32(a, b uint32) uint32
• func UMax64(a, b uint64) uint64
• func UMin64(a, b uint64) uint64
• func WaitForSignal(ctx context.Context, f func(ctx context.Context) error)
• type SysStats
  • func GetStats() SysStats
• type TableOpts
  • func DefaultTableOpts() TableOpts

Functions

func BToMb

func BToMb(b uint64) uint64

func CreateGUID

func CreateGUID() string

func EstSpeed

func EstSpeed(startTime int64, lastTime int64, bytesSent uint64) uint64

EstSpeed will estimate a peers speed using downloaded amount over time

func Exists

func Exists(path string) bool

func FindFile

func FindFile(p string, minRootDir string) string

FindFile will walk up the directory tree until it find a file. Max depth of 4 or the minRootDir directory is matched

func GenRandomBytes

func GenRandomBytes(size int) (blk []byte, err error)

GenRandomBytes returns N bytes of random data

func GetFileSize

func GetFileSize(fileName string) (int64, error)

func HumanBytesString

func HumanBytesString(s uint64) string

HumanBytesString produces a human readable representation of an SI size.

Bytes(82854982) -> 83MB noinspection GoUnusedExportedFunction

func HumanIBytesString

func HumanIBytesString(s uint64) string

HumanIBytesString produces a human readable representation of an IEC size.

IBytes(82854982) -> 79MiB noinspection GoUnusedExportedFunction

func IsDir

func IsDir(path string) bool

func MinInt

func MinInt(a, b int) int

MinInt returns the smallest of two int values

func RandomString

func RandomString(n int) string

func RenderMD

func RenderMD(md string) string

func StringToBool

func StringToBool(s string, def bool) bool

StringToBool converts a string to a bool returning a default value on failure

func StringToFloat64

func StringToFloat64(s string, def float64) float64

StringToFloat64 converts a string to a float64 returning a default value on failure

func StringToInt16

func StringToInt16(s string, def int16) int16

StringToInt16 converts a string to a int16 returning a default value on failure noinspection GoUnusedExportedFunction

func StringToTime

func StringToTime(s string) time.Time

StringToTime converts a string to a time.Time returning a default value on failure

func StringToUInt

func StringToUInt(s string, def int) int

StringToUInt converts a string to a uint32 returning a default value on failure

func StringToUInt16

func StringToUInt16(s string, def uint16) uint16

StringToUInt16 converts a string to a uint16 returning a default value on failure

func StringToUInt32

func StringToUInt32(s string, def uint32) uint32

StringToUInt32 converts a string to a uint32 returning a default value on failure

func StringToUInt64

func StringToUInt64(s string, def uint64) uint64

StringToUInt64 converts a string to a uint32 returning a default value on failure

func TimeToString

func TimeToString(t time.Time) string

TimeToString converts a time.Time to a common RFC1123Z string

func ToTable

func ToTable(rows [][]string, opts TableOpts) string

func UMax

func UMax(a, b uint) uint

UMax is math.Max for uint

func UMax16

func UMax16(a, b uint16) uint16

UMax16 is math.Max for uint16

func UMax32

func UMax32(a, b uint32) uint32

UMax32 is math.Max for uint64

func UMax64

func UMax64(a, b uint64) uint64

UMax64 is math.Max for uint64

func UMin64

func UMin64(a, b uint64) uint64

UMin64 is math.Min for uint64

func WaitForSignal

func WaitForSignal(ctx context.Context, f func(ctx context.Context) error)

WaitForSignal will execute a function when a matching os.Signal is received This is mostly designed to shutdown & cleanup services

Types

type SysStats

type SysStats struct {
	Alloc      uint64
	TotalAlloc uint64
	Sys        uint64
	NumGC      uint32
	GoRoutines int
}

func GetStats

func GetStats() SysStats

type TableOpts

type TableOpts struct {
	Title         string
	Headers       []string
	Padding       int
	DrawRowBorder bool
}

func DefaultTableOpts

func DefaultTableOpts() TableOpts