utils

Documentation

Index

• func All(actions ...func()) func()
• func DefaultBackoff(interval time.Duration) time.Duration
• func Dump(list ...interface{})
• func E(args ...interface{}) []interface{}
• func Exec(name string, args ...string)
• func FileExists(path string) bool
• func IsSyncMapEmpty(s *sync.Map) bool
• func Mkdir(path string) error
• func MustReadBytes(r io.Reader) []byte
• func MustReadJSON(r io.Reader) gjson.Result
• func MustReadString(r io.Reader) string
• func MustToJSON(data interface{}) string
• func MustToJSONBytes(data interface{}) []byte
• func OutputFile(p string, data interface{}) error
• func Pause()
• func RandString(len int) string
• func ReadJSON(r io.Reader) (gjson.Result, error)
• func ReadJSONPathAsString(r io.Reader, path string) (string, error)
• func ReadString(p string) (string, error)
• func Retry(ctx context.Context, s Sleeper, fn func() (stop bool, err error)) error
• func S(tpl string, params ...interface{}) string
• func SDump(v interface{}) string
• func Serve(host string) (string, *http.ServeMux, func())
• func SetCmdStdPipe(cmd *exec.Cmd)
• func Sleep(seconds float64)
• func SyncMapToMap(s *sync.Map) map[string]interface{}
• type Nil
• type Sleeper
  • func BackoffSleeper(init, maxInterval time.Duration, algorithm func(time.Duration) time.Duration) Sleeper
  • func CountSleeper(max int) Sleeper

Functions

func All

func All(actions ...func()) func()

All run all actions concurrently, returns the wait function for all actions.

func DefaultBackoff

func DefaultBackoff(interval time.Duration) time.Duration

DefaultBackoff algorithm: A(n) = A(n-1) * random[1.9, 2.1)

func Dump

func Dump(list ...interface{})

Dump values to logger

func E

func E(args ...interface{}) []interface{}

E if the last arg is error, panic it

func Exec

func Exec(name string, args ...string)

Exec command

func FileExists

func FileExists(path string) bool

FileExists checks if file exists, only for file, not for dir

func IsSyncMapEmpty

func IsSyncMapEmpty(s *sync.Map) bool

IsSyncMapEmpty helper

func Mkdir

func Mkdir(path string) error

Mkdir makes dir recursively

func MustReadBytes

func MustReadBytes(r io.Reader) []byte

MustReadBytes from reader

func MustReadJSON

func MustReadJSON(r io.Reader) gjson.Result

MustReadJSON from reader

func MustReadString

func MustReadString(r io.Reader) string

MustReadString from reader

func MustToJSON

func MustToJSON(data interface{}) string

MustToJSON encode data to json string

func MustToJSONBytes

func MustToJSONBytes(data interface{}) []byte

MustToJSONBytes encode data to json bytes

func OutputFile

func OutputFile(p string, data interface{}) error

OutputFile auto creates file if not exists, it will try to detect the data type and auto output binary, string or json

func Pause

func Pause()

Pause the goroutine forever

func RandString

func RandString(len int) string

RandString generate random string with specified string length

func ReadJSON

func ReadJSON(r io.Reader) (gjson.Result, error)

ReadJSON from reader

func ReadJSONPathAsString

func ReadJSONPathAsString(r io.Reader, path string) (string, error)

ReadJSONPathAsString from reader

func ReadString

func ReadString(p string) (string, error)

ReadString reads file as string

func Retry

func Retry(ctx context.Context, s Sleeper, fn func() (stop bool, err error)) error

Retry fn and sleeper until fn returns true or s returns error

func S

func S(tpl string, params ...interface{}) string

S Template render, the params is key-value pairs

func SDump

func SDump(v interface{}) string

SDump a value

func Serve

func Serve(host string) (string, *http.ServeMux, func())

Serve a port, if host is empty a random port will be used.

func SetCmdStdPipe

func SetCmdStdPipe(cmd *exec.Cmd)

SetCmdStdPipe command

func Sleep

func Sleep(seconds float64)

Sleep the goroutine for specified seconds, such as 2.3 seconds

func SyncMapToMap

func SyncMapToMap(s *sync.Map) map[string]interface{}

SyncMapToMap convertor

Types

type Nil

type Nil struct{}

Nil type

type Sleeper

type Sleeper func(context.Context) error

Sleeper sleeps for sometime, returns the reason to wake, if ctx is done release resource

func BackoffSleeper

func BackoffSleeper(init, maxInterval time.Duration, algorithm func(time.Duration) time.Duration) Sleeper

BackoffSleeper returns a sleeper that sleeps in a backoff manner every time get called. If algorithm is nil, DefaultBackoff will be used. Set interval and maxInterval to the same value to make it a constant interval sleeper. If maxInterval is not greater than 0, it will wake immediately.

func CountSleeper

func CountSleeper(max int) Sleeper

CountSleeper wake when counts to max and return