utils

Documentation

Overview

Package utils ...

Index

• Variables
• func AbsolutePaths(paths []string) []string
• func All(actions ...func()) func()
• func CropImage(bin []byte, quality, x, y, width, height int) ([]byte, error)
• func DefaultBackoff(interval time.Duration) time.Duration
• func Dump(list ...interface{}) string
• func E(args ...interface{}) []interface{}
• func EscapeGoString(s string) string
• func Exec(line string, rest ...string) string
• func ExecLine(std bool, line string, rest ...string) string
• func FileExists(path string) bool
• func FormatCLIArgs(args []string) string
• func Mkdir(path string) error
• func MustToJSON(data interface{}) string
• func MustToJSONBytes(data interface{}) []byte
• func Noop()
• func OutputFile(p string, data interface{}) error
• func Pause()
• func RandString(len int) string
• 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 Sleep(seconds float64)
• type ErrMaxSleepCount
  • func (e *ErrMaxSleepCount) Error() string
  • func (e *ErrMaxSleepCount) Is(err error) bool
• type IdleCounter
  • func NewIdleCounter(d time.Duration) *IdleCounter
  • func (de *IdleCounter) Add()
  • func (de *IdleCounter) Done()
  • func (de *IdleCounter) Wait(ctx context.Context)
• type Log
  • func MultiLogger(list ...Logger) Log
  • func (l Log) Println(msg ...interface{})
• type Logger
• type Sleeper
  • func BackoffSleeper(initInterval, maxInterval time.Duration, ...) Sleeper
  • func CountSleeper(max int) Sleeper
  • func EachSleepers(list ...Sleeper) Sleeper
  • func RaceSleepers(list ...Sleeper) Sleeper

Variables

var InContainer = FileExists("/.dockerenv") || FileExists("/.containerenv")

InContainer will be true if is inside container environment, such as docker

var Panic = func(v interface{}) { panic(v) }

Panic is the same as the built-in panic

var TestEnvs = map[string]string{
	"GODEBUG": "tracebackancestors=100",
}

TestEnvs for testing

Functions

func AbsolutePaths

func AbsolutePaths(paths []string) []string

AbsolutePaths returns absolute paths of files in current working directory

func All

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

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

func CropImage

func CropImage(bin []byte, quality, x, y, width, height int) ([]byte, error)

CropImage by the specified box, quality is only for jpeg bin.

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

Dump values for debugging

func E

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

E if the last arg is error, panic it

func EscapeGoString

func EscapeGoString(s string) string

EscapeGoString not using encoding like base64 or gzip because of they will make git diff every large for small change

func Exec

func Exec(line string, rest ...string) string

Exec command

func ExecLine

func ExecLine(std bool, line string, rest ...string) string

ExecLine of command

func FileExists

func FileExists(path string) bool

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

func FormatCLIArgs

func FormatCLIArgs(args []string) string

FormatCLIArgs into one line string

func Mkdir

func Mkdir(path string) error

Mkdir makes dir recursively

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()

Noop does nothing

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 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 Sleep

func Sleep(seconds float64)

Sleep the goroutine for specified seconds, such as 2.3 seconds

Types

type ErrMaxSleepCount

type ErrMaxSleepCount struct {
	// Max count
	Max int
}

ErrMaxSleepCount type

func (*ErrMaxSleepCount) Error

func (e *ErrMaxSleepCount) Error() string

Error interface

func (*ErrMaxSleepCount) Is

func (e *ErrMaxSleepCount) Is(err error) bool

Is interface

type IdleCounter

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

IdleCounter is similar to sync.WaitGroup but it only resolves if no jobs for specified duration.

func NewIdleCounter

func NewIdleCounter(d time.Duration) *IdleCounter

NewIdleCounter ...

func (*IdleCounter) Add

func (de *IdleCounter) Add()

Add ...

func (*IdleCounter) Done

func (de *IdleCounter) Done()

Done ...

func (*IdleCounter) Wait

func (de *IdleCounter) Wait(ctx context.Context)

Wait ...

type Log

type Log func(msg ...interface{})

Log type for Println

func MultiLogger

func MultiLogger(list ...Logger) Log

MultiLogger is similar to https://golang.org/pkg/io/#MultiWriter

func (Log) Println

func (l Log) Println(msg ...interface{})

Println interface

type Logger

type Logger interface {
	// Same as fmt.Printf
	Println(...interface{})
}

Logger interface

var LoggerQuiet Logger = Log(func(_ ...interface{}) {})

LoggerQuiet does nothing

type Sleeper

type Sleeper func(context.Context) error

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

func BackoffSleeper

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

BackoffSleeper returns a sleeper that sleeps in a backoff manner every time get called. The sleep interval of the sleeper will grow from initInterval to maxInterval by the specified algorithm, then use maxInterval as the interval. If maxInterval is not greater than 0, the sleeper will wake immediately. If algorithm is nil, DefaultBackoff will be used.

func CountSleeper

func CountSleeper(max int) Sleeper

CountSleeper wakes immediately. When counts to the max returns *ErrMaxSleepCount

func EachSleepers

func EachSleepers(list ...Sleeper) Sleeper

EachSleepers returns a sleeper wakes up when each sleeper is awake. If a sleeper returns error, it will wake up immediately.

func RaceSleepers

func RaceSleepers(list ...Sleeper) Sleeper

RaceSleepers returns a sleeper wakes up when one of the sleepers wakes.