utils

Documentation

Index

• Constants
• Variables
• func All(actions ...func()) func()
• func C(str interface{}, color string) string
• func ClearScreen() error
• 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 S(tpl string, params ...interface{}) string
• func Sdump(val interface{}) string
• func Sleep(seconds float64)
• func Try(fn func()) (err interface{})
• type Event
• type JSONResult
  • func JSON(data interface{}) JSONResult
• type Nil
• type Observable
  • func NewObservable() *Observable
  • func (o *Observable) Count() int
  • func (o *Observable) Publish(e Event)
  • func (o *Observable) Subscribe() *Subscriber
  • func (o *Observable) Unsubscribe(s *Subscriber)
  • func (o *Observable) Until(ctx context.Context, check func(Event) bool) (Event, error)
• type Subscriber
  • func (s *Subscriber) Filter(filter func(Event) bool) chan Event

Constants

const Version = "v0.20.7"

Version version the project

Variables

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 Dump

func Dump(val interface{})

Dump ...

func E

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

E 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 execution

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 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 execution 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 Event

type Event interface{}

Event of the observale

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 Observable

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

Observable is a thread-safe event helper

func NewObservable

func NewObservable() *Observable

NewObservable creates a new observable

func (*Observable) Count

func (o *Observable) Count() int

Count returns the number of subscribers

func (*Observable) Publish

func (o *Observable) Publish(e Event)

Publish event to all subscribers, no internal goroutine is used, so the publish can block the goroutine. Use goroutine or buffer to prevent the blocking.

func (*Observable) Subscribe

func (o *Observable) Subscribe() *Subscriber

Subscribe returns a subscriber to emit events

func (*Observable) Unsubscribe

func (o *Observable) Unsubscribe(s *Subscriber)

Unsubscribe from the observable

func (*Observable) Until

func (o *Observable) Until(ctx context.Context, check func(Event) bool) (Event, error)

Until check returns true keep waiting

type Subscriber

type Subscriber struct {
	C chan Event
	// contains filtered or unexported fields
}

Subscriber of the observable

func (*Subscriber) Filter

func (s *Subscriber) Filter(filter func(Event) bool) chan Event

Filter events