util

Documentation

Index

• Constants
• func FNV32(s string) uint32
• func FilterSimpleArgs(args []interface{}) (simpleArgs []interface{})
• func IsPaperTrade() bool
• func LogErr(err error, msgAndArgs ...interface{}) bool
• func MaskKey(key string) string
• func NewValidLimiter(r rate.Limit, b int) (*rate.Limiter, error)
• func ParseRateLimitSyntax(desc string) (*rate.Limiter, error)
• func ReadJsonFile(file string, obj interface{}) error
• func SafeMkdirAll(p string) error
• func ShouldDelay(l *rate.Limiter, minInterval time.Duration) time.Duration
• func StringSliceContains(slice []string, needle string) bool
• func StringSplitByLength(s string, length int) (result []string)
• func TryLock(lock *sync.RWMutex) bool
• func TryRLock(lock *sync.RWMutex) bool
• func UnixMilli() int64
• func WriteJsonFile(p string, obj interface{}) error
• type Reonce
  • func (o *Reonce) Do(f func())
  • func (o *Reonce) Reset()
• type Response
  • func NewResponse(r *http.Response) (response *Response, err error)
  • func (r *Response) DecodeJSON(o interface{}) error
  • func (r *Response) IsError() bool
  • func (r *Response) IsHTML() bool
  • func (r *Response) IsJSON() bool
  • func (r *Response) String() string
• type VolatileMemory
  • func NewDetectorCache() *VolatileMemory
  • func (i *VolatileMemory) IsObjectFresh(obj interface{}, ttl time.Duration) bool
  • func (i *VolatileMemory) IsTextFresh(text string, ttl time.Duration) bool

Constants

const Pointer = reflect.Pointer

Functions

func FNV32

func FNV32(s string) uint32

func FilterSimpleArgs

func FilterSimpleArgs(args []interface{}) (simpleArgs []interface{})

FilterSimpleArgs filters out the simple type arguments int, string, bool, and []byte

func IsPaperTrade

func IsPaperTrade() bool

func LogErr

func LogErr(err error, msgAndArgs ...interface{}) bool

LogErr logs the error with the message and arguments if the error is not nil. It returns true if the error is not nil. Examples: LogErr(err) LogErr(err, "error message") LogErr(err, "error message %s", "with argument")

func MaskKey

func MaskKey(key string) string

func NewValidLimiter

func NewValidLimiter(r rate.Limit, b int) (*rate.Limiter, error)

func ParseRateLimitSyntax

func ParseRateLimitSyntax(desc string) (*rate.Limiter, error)

ParseRateLimitSyntax parses the rate limit syntax into the rate.Limiter parameters sample inputs:

	 2+1/5s (2 initial tokens, 1 token per 5 seconds)
	 5+3/1m (5 initial tokens, 3 tokens per minute)
     3m (3 tokens per minute)
     1/3m (1 token per 3 minutes)

func ReadJsonFile

func ReadJsonFile(file string, obj interface{}) error

func SafeMkdirAll

func SafeMkdirAll(p string) error

func ShouldDelay

func ShouldDelay(l *rate.Limiter, minInterval time.Duration) time.Duration

func StringSliceContains

func StringSliceContains(slice []string, needle string) bool

func StringSplitByLength

func StringSplitByLength(s string, length int) (result []string)

func TryLock

func TryLock(lock *sync.RWMutex) bool

func TryRLock

func TryRLock(lock *sync.RWMutex) bool

func UnixMilli

func UnixMilli() int64

func WriteJsonFile

func WriteJsonFile(p string, obj interface{}) error

Types

type Reonce

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

func (*Reonce) Do

func (o *Reonce) Do(f func())

func (*Reonce) Reset

func (o *Reonce) Reset()

type Response

type Response struct {
	*http.Response

	// Body overrides the composited Body field.
	Body []byte
}

Response is wrapper for standard http.Response and provides more methods.

func NewResponse

func NewResponse(r *http.Response) (response *Response, err error)

NewResponse is a wrapper of the http.Response instance, it reads the response body and close the file.

func (*Response) DecodeJSON

func (r *Response) DecodeJSON(o interface{}) error

func (*Response) IsError

func (r *Response) IsError() bool

func (*Response) IsHTML

func (r *Response) IsHTML() bool

func (*Response) IsJSON

func (r *Response) IsJSON() bool

func (*Response) String

func (r *Response) String() string

String converts response body to string. An empty string will be returned if error.

type VolatileMemory

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

func NewDetectorCache

func NewDetectorCache() *VolatileMemory

func (*VolatileMemory) IsObjectFresh

func (i *VolatileMemory) IsObjectFresh(obj interface{}, ttl time.Duration) bool

func (*VolatileMemory) IsTextFresh

func (i *VolatileMemory) IsTextFresh(text string, ttl time.Duration) bool