utils

Documentation

Index

• Constants
• Variables
• func All(actions ...func()) func()
• func C(str interface{}, color string) string
• func ClearScreen() error
• func DefaultBackoff(interval time.Duration) time.Duration
• func Dump(val interface{})
• func E(args ...interface{}) []interface{}
• func E1(arg interface{}, err error) interface{}
• func Err(v ...interface{})
• func ErrArg(args ...interface{}) error
• func Log(v ...interface{})
• func MustToJSON(data interface{}) string
• func MustToJSONBytes(data interface{}) []byte
• func Noop(_ ...interface{})
• func Pause()
• func RandBytes(len int) []byte
• func RandString(len int) string
• func Retry(ctx context.Context, s Sleeper, fn func() (stop bool, err error)) error
• func S(tpl string, params ...interface{}) string
• func Sdump(val interface{}) string
• func Sleep(seconds float64)
• func Try(fn func()) (err interface{})
• type ErrInjector
  • func (e *ErrInjector) CountInject(times int, err error)
  • func (e *ErrInjector) E(err error) error
  • func (e *ErrInjector) Inject(fn func(error) error)
• type JSONResult
  • func JSON(data interface{}) JSONResult
• type Nil
• type Sleeper
  • func BackoffSleeper(init, maxInterval time.Duration, algorithm func(time.Duration) time.Duration) Sleeper
  • func CountSleeper(max int) Sleeper
  • func MergeSleepers(list ...Sleeper) Sleeper

Constants

const Version = "v0.25.5"

Version version the project

Variables

var ErrMaxSleepCount = errors.New("max sleep count")

ErrMaxSleepCount ...

var Stderr = stderr()

Stderr ...

var Stdout = stdout()

Stdout ...

Functions

func All

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

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

func C

func C(str interface{}, color string) string

C color terminal string

func ClearScreen

func ClearScreen() error

ClearScreen ...

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(val interface{})

Dump ...

func E

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

E if the last arg is error, panic it

func E1

func E1(arg interface{}, err error) interface{}

E1 if the second arg is error panic it, or return the first arg

func Err

func Err(v ...interface{})

Err log to stderr with timestamp and stack trace

func ErrArg

func ErrArg(args ...interface{}) error

ErrArg get the last arg as error

func Log

func Log(v ...interface{})

Log log to stdout with timestamp

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 Noop

func Noop(_ ...interface{})

Noop swallow all args and do nothing

func Pause

func Pause()

Pause the goroutine forever

func RandBytes

func RandBytes(len int) []byte

RandBytes generate random bytes with specified byte length

func RandString

func RandString(len int) string

RandString generate random string with specified string length

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(val interface{}) string

Sdump ...

func Sleep

func Sleep(seconds float64)

Sleep the goroutine for specified seconds, such as 2.3 seconds

func Try

func Try(fn func()) (err interface{})

Try try fn with recover, return the panic as value

Types

type ErrInjector

type ErrInjector struct {
	// contains filtered or unexported fields
}

ErrInjector let you easily mock error for testing

func (*ErrInjector) CountInject

func (e *ErrInjector) CountInject(times int, err error)

CountInject inject err after E is called with specified times

func (*ErrInjector) E

func (e *ErrInjector) E(err error) error

E inject error

func (*ErrInjector) Inject

func (e *ErrInjector) Inject(fn func(error) error)

Inject the fn and enable the enjection, call it with nil to disable injection

type JSONResult

type JSONResult = *gjson.Result

JSONResult shortcut for gjson.Result

func JSON

func JSON(data interface{}) JSONResult

JSON parse json for easily access the value from json path

type Nil

type Nil struct{}

Nil used to create empty channel

type Sleeper

type Sleeper func(ctx 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

func MergeSleepers

func MergeSleepers(list ...Sleeper) Sleeper

MergeSleepers into one, wakes when first sleeper wakes. Such as you want to poll to check if wifi is connected, when you poll you also want to do do the check whenever wifi driver is enabled, then you can merge BackoffSleeper and ChannelSleeper to achieve it.