utils

package module

Go to main page

Versions in this module

v4

v4.10.0

Jul 17, 2024

Changes in this version

+ var RegexpOidFormat = regexp.MustCompile(`^\d(?:\.\d+){0,}$`)

+ func GetEnvInsensitive(key string) (values []string)

+ func NewLruCache[K comparable, V any](size int, ttl time.Duration) *sieve.Sieve[K, V]

+ func OpenURLInDefaultBrowser(ctx context.Context, url string) error

+ func ParseObjectIdentifier(val string) (oid asn1.ObjectIdentifier, err error)

v4.9.1

Mar 18, 2024

v4.9.0

Feb 28, 2024

Changes in this version

+ type PrettyBuildInfoOption func(*prettyBuildInfoOption)

+ func WithPrettyBuildInfoDeps() PrettyBuildInfoOption

+ type TtlCache struct

+ func NewTtlCache[T any]() *TtlCache[T]

+ func (c *TtlCache[T]) Close()

+ func (c *TtlCache[T]) Delete(key string)

+ func (c *TtlCache[T]) Get(key string) (val T, ok bool)

+ func (c *TtlCache[T]) Set(key string, val T, ttl time.Duration)

v4.8.0

Jan 16, 2024

Changes in this version

+ func FilterSlice[T any](s []T, f func(v T) bool) []T

+ func ParseTimeWithTruncate(layout, value string, precision time.Duration) (t time.Time, err error)

+ func TimeEqual(ts1, ts2 time.Time, difference time.Duration) bool

v4.7.3

Jan 5, 2024

Changes in this version

+ var Number2Roman = common.Number2Roman

v4.7.2

Jan 3, 2024

v4.7.1

Dec 26, 2023

Changes in this version

+ func CombineSortedChain[T Sortable](sortOrder common.SortOrder, chans ...chan T) (result chan T, err error)

v4.7.0

Dec 21, 2023

Changes in this version

+ func RemoveEmptyVal(m map[string]any) map[string]any

+ func ReverseSlice[T any](s []T)

+ func SanitizeCMDArgs(args []string) (sanitizedArgs []string, err error)

v4.6.0

Oct 24, 2023

Changes in this version

+ const TracingKey

+ func IsPanic2(f func()) (err error)

+ func PaddingLeft(s string, padStr string, pLen int) string

+ func RandomNonZeroUint64() (uint64, error)

+ func RegexNamedSubMatch2(r *regexp.Regexp, str string) (subMatchMap map[string]string, err error)

+ func UUID4() string

+ func UUID7() string

+ type JaegerTracingID string

+ func NewJaegerTracingID(traceID, spanID, parentSpanID uint64, flag byte) (traceVal JaegerTracingID, err error)

+ func (t JaegerTracingID) NewSpan() (JaegerTracingID, error)

+ func (t JaegerTracingID) Parse() (traceID, spanID, parentSpanID uint64, flag byte, err error)

+ func (t JaegerTracingID) String() string

+ type UUID7Itf interface

+ Empty func() bool

+ String func() string

+ Timestamp func() uint64

+ func ParseUUID7(val string) (UUID7Itf, error)

v4.5.2

Sep 28, 2023

Changes in this version

type RateLimiter

+ func (t *RateLimiter) Len() int

v4.5.1

Sep 5, 2023

Changes in this version

+ type RateLimiter struct

+ func NewRateLimiter(ctx context.Context, args RateLimiterArgs) (ratelimiter *RateLimiter, err error)

+ func (t *RateLimiter) Allow() bool

+ func (t *RateLimiter) AllowN(n int) bool

+ func (t *RateLimiter) Close()

+ type RateLimiterArgs struct

+ Max int

+ NPerSec int

v4.5.0

Aug 24, 2023

Changes in this version

+ func CloseWithLog(ins interface{ ... }, logger interface{ ... })

+ func FlushWithLog(ins interface{ ... }, logger interface{ ... })

+ func JoinFilepath(paths ...string) (result string, err error)

+ func LogErr(f func() error, logger interface{ ... })

+ func ReplaceFileAtomic(path string, in io.ReadCloser, perm os.FileMode) error

+ func RunCMD2(ctx context.Context, app string, args []string, envs []string, ...) (err error)

+ func WaitTCPOpen(ctx context.Context, ip string, port int) error

type ListFilesInDirOptionFunc

+ func ListFilesInDirFilter(filter func(fname string) bool) ListFilesInDirOptionFunc

+ func ListFilesInDirRecursive() ListFilesInDirOptionFunc

v4.4.0

Jul 3, 2023

Changes in this version

+ func FileHash(hashType HashTypeInterface, filepath string) (signature []byte, err error)

+ func MockStdout() (recover func(), stdout *os.File, err error)

type HashType

+ const HashTypeSha1

v4.3.0

May 28, 2023

Changes in this version

+ func Input(hint string) (input string, err error)

v4.2.1

May 12, 2023

Changes in this version

+ func InputPassword(hint string, validator func(string) error) (passwd string, err error)

+ func InputYes(hint string) (ok bool, err error)

+ func NewTmpFile(reader io.Reader) (*os.File, error)

+ func WaitComplete(ctx context.Context, goros ...func(ctx context.Context) error) (err error)

type GoroutineTest

+ func (t *GoroutineTest) Cleanup(f func())

+ func (t *GoroutineTest) Error(args ...any)

+ func (t *GoroutineTest) Errorf(format string, args ...any)

+ func (t *GoroutineTest) Fail()

+ func (t *GoroutineTest) Failed() bool

+ func (t *GoroutineTest) Fatal(args ...any)

+ func (t *GoroutineTest) Fatalf(format string, args ...any)

+ func (t *GoroutineTest) Helper()

+ func (t *GoroutineTest) Log(args ...any)

+ func (t *GoroutineTest) Logf(format string, args ...any)

+ func (t *GoroutineTest) Name() string

+ func (t *GoroutineTest) Setenv(key, value string)

+ func (t *GoroutineTest) Skip(args ...any)

+ func (t *GoroutineTest) SkipNow()

+ func (t *GoroutineTest) Skipf(format string, args ...any)

+ func (t *GoroutineTest) Skipped() bool

+ func (t *GoroutineTest) TempDir() string

+ type RWManager struct

+ func (m *RWManager) Lock(name string)

+ func (m *RWManager) RLock(name string)

+ func (m *RWManager) RUnlock(name string)

+ func (m *RWManager) Unlock(name string)

+ type RWManagerInterface interface

+ Lock func(name string)

+ RLock func(name string)

+ RUnlock func(name string)

+ Unlock func(name string)

v4.2.0

Apr 14, 2023

Changes in this version

+ func FileHashSharding(fname string) string

v4.1.0

Mar 14, 2023

Changes in this version

+ func Hash(hashType HashTypeInterface, content io.Reader) (signature []byte, err error)

+ func HashSHA128String(val string) string

+ func HashSHA256String(val string) string

+ func HashVerify(hashType HashTypeInterface, content io.Reader, signature []byte) (err error)

+ func HashXxhashString(val string) string

+ func RandomChoice(arr []T, n int) (got []T)

+ type Delayer struct

+ func NewDelay(d time.Duration) *Delayer

+ func (d *Delayer) Wait()

type HTTPClientOptFunc

+ func WithHTTPClientProxy(proxy string) HTTPClientOptFunc

+ func WithHTTPTlsConfig(cfg *tls.Config) HTTPClientOptFunc

+ type HashType string

+ const HashTypeMD5

+ const HashTypeSha256

+ const HashTypeSha512

+ const HashTypeXxhash

+ func (h HashType) Hasher() (hash.Hash, error)

+ func (h HashType) String() string

+ type HashTypeInterface interface

+ Hasher func() (hash.Hash, error)

+ String func() string

v4.0.0

Mar 1, 2023

Changes in this version

+ const ANSIColorBgBlack

+ const ANSIColorBgBlue

+ const ANSIColorBgCyan

+ const ANSIColorBgGreen

+ const ANSIColorBgHiBlack

+ const ANSIColorBgHiBlue

+ const ANSIColorBgHiCyan

+ const ANSIColorBgHiGreen

+ const ANSIColorBgHiMagenta

+ const ANSIColorBgHiRed

+ const ANSIColorBgHiWhite

+ const ANSIColorBgHiYellow

+ const ANSIColorBgMagenta

+ const ANSIColorBgRed

+ const ANSIColorBgWhite

+ const ANSIColorBgYellow

+ const ANSIColorBlinkRapid

+ const ANSIColorBlinkSlow

+ const ANSIColorBold

+ const ANSIColorConcealed

+ const ANSIColorCrossedOut

+ const ANSIColorEscape

+ const ANSIColorFaint

+ const ANSIColorFgBlack

+ const ANSIColorFgBlue

+ const ANSIColorFgCyan

+ const ANSIColorFgGreen

+ const ANSIColorFgHiBlack

+ const ANSIColorFgHiBlue

+ const ANSIColorFgHiCyan

+ const ANSIColorFgHiGreen

+ const ANSIColorFgHiMagenta

+ const ANSIColorFgHiRed

+ const ANSIColorFgHiWhite

+ const ANSIColorFgHiYellow

+ const ANSIColorFgMagenta

+ const ANSIColorFgRed

+ const ANSIColorFgWhite

+ const ANSIColorFgYellow

+ const ANSIColorItalic

+ const ANSIColorReset

+ const ANSIColorReverseVideo

+ const ANSIColorUnderline

+ const BaseHex

+ const BitSize64

+ const HTTPHeaderContentType

+ const HTTPHeaderContentTypeValJSON

+ const HTTPHeaderHost

+ const HTTPHeaderReferer

+ const Nano2Sec

+ const TimeFormatDate

+ var Clock = NewClock(context.Background(), defaultClockInterval)

+ var DecodeByHex = hex.DecodeString

+ var EncodeByHex = hex.EncodeToString

+ var ErrAsyncTask = errors.New("async task error")

+ var ForceGC = ForceGCBlocking

+ var JSON = json

+ var ParseTs2String = ParseUnix2String

+ var ParseTs2Time = ParseTs2UTC

+ var ParseTs2UTC = ParseUnix2UTC

+ var TimeZoneShanghai *time.Location

+ var TimeZoneUTC = time.UTC

+ var TriggerGC = ForceGCUnBlocking

+ var UnixNano2UTC = ParseUnixNano2UTC

+ func AbsInt32(v int32) int32

+ func AbsInt64(v int64) int64

+ func AutoGC(ctx context.Context, opts ...GcOptFunc) (err error)

+ func Bytes2Str(b []byte) string

+ func CheckResp(resp *http.Response) error

+ func Color(color int, s string) string

+ func Contains(collection []V, ele V) bool

+ func ConvertMap2StringKey(inputMap any) map[string]any

+ func CopyFile(src, dst string, optfs ...CopyFileOptionFunc) (err error)

+ func CostSecs(cost time.Duration) string

+ func DecodeByBase64(encoded string) ([]byte, error)

+ func Dedent(v string, optfs ...DedentOptFunc) string

+ func DeepClone(src any) (dst any)

+ func DirSize(path string) (size int64, err error)

+ func EmptyAllChans(chans ...chan T)

+ func EncodeByBase64(raw []byte) string

+ func FallBack(orig func() any, fallback any) (ret any)

+ func FileExists(path string) (bool, error)

+ func FileMD5(path string) (hashed string, err error)

+ func FileSHA1(path string) (hashed string, err error)

+ func FlattenMap(data map[string]any, delimiter string)

+ func ForceGCBlocking()

+ func ForceGCUnBlocking()

+ func GetFuncName(f any) string

+ func GetStructFieldByName(st any, fieldName string) any

+ func GracefulCancel(cancel func())

+ func HTTPInvalidStatusError(statusCode int) error

+ func HasField(st any, fieldName string) bool

+ func HasMethod(st any, methodName string) bool

+ func HumanReadableByteCount(bytes int64, si bool) (ret string)

+ func IntersectSortedChans(chans ...chan T) (result chan T, err error)

+ func IsDir(path string) (bool, error)

+ func IsDirWritable(dir string) (err error)

+ func IsEmpty(val any) bool

+ func IsFile(path string) (bool, error)

+ func IsFileATimeChanged(path string, expectATime time.Time) (changed bool, newATime time.Time, err error)

+ func IsPanic(f func()) (isPanic bool)

+ func IsPtr(t any) bool

+ func IsRemoteUDPPortOpen(addr string) error

+ func JumpHash(key uint64, numBuckets int) (int32, error)

+ func ListFilesInDir(dir string, optfs ...ListFilesInDirOptionFunc) (files []string, err error)

+ func MD5JSON(data any) (string, error)

+ func Max(vals ...T) T

+ func Min(vals ...T) T

+ func MoveFile(src, dst string) (err error)

+ func NewHTTPClient(opts ...HTTPClientOptFunc) (c *http.Client, err error)

+ func NewRand() *rand.Rand

+ func NewTmpFileForContent(content []byte) (path string, err error)

+ func NilInterface(data any) bool

+ func NotEmpty(val any, name string) error

+ func OptionalVal(ptr *T, optionalVal T) T

+ func PanicIfErr(err error)

+ func ParseHex2UTC(ts string) (t time.Time, err error)

+ func ParseHexNano2UTC(ts string) (t time.Time, err error)

+ func ParseUnix2String(ts int64, layout string) string

+ func ParseUnix2UTC(ts int64) time.Time

+ func ParseUnixNano2UTC(ts int64) time.Time

+ func Pipeline(funcs []func(T) error, v T) (T, error)

+ func PrettyBuildInfo() string

+ func RaceErr(gs ...func() error) (err error)

+ func RaceErrWithCtx(ctx context.Context, gs ...func(context.Context) error) error

+ func RandomBytesWithLength(n int) ([]byte, error)

+ func RandomStringWithLength(n int) string

+ func RegexNamedSubMatch(r *regexp.Regexp, str string, subMatchMap map[string]string) error

+ func RemoveEmpty(vs []string) (r []string)

+ func RenderTemplate(tplContent string, args any) ([]byte, error)

+ func RenderTemplateFile(tplFile string, args any) ([]byte, error)

+ func ReplaceFile(path string, content []byte, perm os.FileMode) error

+ func ReplaceFileStream(path string, in io.ReadCloser, perm os.FileMode) error

+ func RequestJSON(method, url string, request *RequestData, resp any) (err error)

+ func RequestJSONWithClient(httpClient *http.Client, method, url string, request *RequestData, resp any) (err error)

+ func Round(val float64, d int) float64

+ func RunCMD(ctx context.Context, app string, args ...string) (stdout []byte, err error)

+ func RunCMDWithEnv(ctx context.Context, app string, args []string, envs []string) (stdout []byte, err error)

+ func RunWithTimeout(timeout time.Duration, f func() error) error

+ func SecRandInt(n int) (int, error)

+ func SecRandomBytesWithLength(n int) ([]byte, error)

+ func SecRandomStringWithLength(n int) (string, error)

+ func SetInternalClock(interval time.Duration)

+ func SetStructFieldsBySlice(structs, vals any) (err error)

+ func SilentClose(v interface{ ... })

+ func SilentFlush(v interface{ ... })

+ func SleepWithContext(ctx context.Context, duration time.Duration)

+ func StopSignal(optfs ...StopSignalOptFunc) (stopCh <-chan struct{})

+ func Str2Bytes(s string) []byte

+ func TemplateWithMap(tpl string, data map[string]any) string

+ func TemplateWithMapAndRegexp(tplReg *regexp.Regexp, tpl string, data map[string]any) string

+ func TrimEleSpaceAndRemoveEmpty(vs []string) (r []string)

+ func URLMasking(url, mask string) string

+ func UTCNow() time.Time

+ func UUID1() string

+ func UniqueStrings(vs []string) (r []string)

+ func ValidateFileHash(filepath string, hashed string) error

+ func WatchFileChanging(ctx context.Context, files []string, callback func(fsnotify.Event)) error

+ func Wrap(err error, msg string) error

+ type AsyncTask struct

+ func NewAsyncTask(ctx context.Context, store AsyncTaskStoreInterface) (*AsyncTask, error)

+ func (t *AsyncTask) ID() string

+ func (t *AsyncTask) SetDone(ctx context.Context, data string) (err error)

+ func (t *AsyncTask) SetError(ctx context.Context, errMsg string) (err error)

+ func (t *AsyncTask) Status() AsyncTaskStatus

+ type AsyncTaskInterface interface

+ ID func() string

+ SetDone func(ctx context.Context, data string) (err error)

+ SetError func(ctx context.Context, errMsg string) (err error)

+ Status func() AsyncTaskStatus

+ type AsyncTaskResult struct

+ Data string

+ Err string

+ Status AsyncTaskStatus

+ TaskID string

+ type AsyncTaskStatus uint

+ const AsyncTaskStatusDone

+ const AsyncTaskStatusFailed

+ const AsyncTaskStatusPending

+ const AsyncTaskStatusUnspecified

+ func (s AsyncTaskStatus) String() string

+ type AsyncTaskStoreInterface interface

+ Delete func(ctx context.Context, taskID string) (err error)

+ Get func(ctx context.Context, taskID string) (result *AsyncTaskResult, err error)

+ Heartbeat func(ctx context.Context, taskID string) (alived bool, err error)

+ New func(ctx context.Context) (result *AsyncTaskResult, err error)

+ Set func(ctx context.Context, taskID string, result *AsyncTaskResult) (err error)

+ type AsyncTaskStoreMemory struct

+ func NewAsyncTaskStoreMemory() *AsyncTaskStoreMemory

+ func (s *AsyncTaskStoreMemory) Delete(ctx context.Context, taskID string) (err error)

+ func (s *AsyncTaskStoreMemory) Get(ctx context.Context, taskID string) (result *AsyncTaskResult, err error)

+ func (s *AsyncTaskStoreMemory) Heartbeat(ctx context.Context, taskID string) (alived bool, err error)

+ func (s *AsyncTaskStoreMemory) New(ctx context.Context) (result *AsyncTaskResult, err error)

+ func (s *AsyncTaskStoreMemory) Set(ctx context.Context, taskID string, result *AsyncTaskResult) (err error)

+ type ClockItf interface

+ Close func()

+ GetDate func() (time.Time, error)

+ GetNanoTimeInHex func() string

+ GetTimeInHex func() string

+ GetTimeInRFC3339Nano func() string

+ GetUTCNow func() time.Time

+ Interval func() time.Duration

+ SetInterval func(interval time.Duration)

+ type ClockT struct

+ func NewClock(ctx context.Context, refreshInterval time.Duration) *ClockT

+ func (c *ClockT) Close()

+ func (c *ClockT) GetDate() (time.Time, error)

+ func (c *ClockT) GetNanoTimeInHex() string

+ func (c *ClockT) GetTimeInHex() string

+ func (c *ClockT) GetTimeInRFC3339Nano() string

+ func (c *ClockT) GetUTCNow() time.Time

+ func (c *ClockT) Interval() time.Duration

+ func (c *ClockT) SetInterval(interval time.Duration)

+ type CopyFileOptionFunc func(o *copyFileOption) error

+ func Overwrite() CopyFileOptionFunc

+ func WithFileFlag(flag int) CopyFileOptionFunc

+ func WithFileMode(perm fs.FileMode) CopyFileOptionFunc

+ type DedentOptFunc func(opt *dedentOpt)

+ func WithReplaceTabBySpaces(spaces int) DedentOptFunc

+ type ExpCache struct

+ func NewExpCache(ctx context.Context, ttl time.Duration) *ExpCache[T]

+ func (c *ExpCache[T]) Delete(key string)

+ func (c *ExpCache[T]) Load(key string) (data T, ok bool)

+ func (c *ExpCache[T]) LoadAndDelete(key string) (data T, ok bool)

+ func (c *ExpCache[T]) Store(key string, val T)

+ type ExpCacheInterface interface

+ Delete func(key string)

+ Load func(key string) (data T, ok bool)

+ LoadAndDelete func(key string) (data T, ok bool)

+ Store func(key string, val T)

+ type ExpiredRLock struct

+ func NewExpiredRLock(ctx context.Context, exp time.Duration) (el *ExpiredRLock, err error)

+ func (e *ExpiredRLock) GetLock(key string) *sync.RWMutex

+ type FLock interface — darwin/amd64, js/wasm, linux/amd64

+ Lock func() error

+ Unlock func() error

+ func NewFlock(lockFilePath string) FLock

+ type GcOptFunc func(*gcOption) error

+ func WithGCMemLimitFilePath(path string) GcOptFunc

+ func WithGCMemRatio(ratio int) GcOptFunc

+ type GoroutineTest struct

+ func NewGoroutineTest(t testing.TB, cancel func()) *GoroutineTest

+ func (t *GoroutineTest) FailNow()

+ type HTTPClientOptFunc func(*httpClientOption) error

+ func WithHTTPClientInsecure() HTTPClientOptFunc

+ func WithHTTPClientMaxConn(maxConn int) HTTPClientOptFunc

+ func WithHTTPClientTimeout(timeout time.Duration) HTTPClientOptFunc

+ type LRUExpiredMap struct

+ func NewLRUExpiredMap(ctx context.Context, ttl time.Duration, new func() any) (el *LRUExpiredMap, err error)

+ func (e *LRUExpiredMap) Get(key string) any

+ type ListFilesInDirOptionFunc func(*listFilesInDirOption) error

+ func Recursive() ListFilesInDirOptionFunc

+ type Mutex struct

+ func NewMutex() *Mutex

+ func (m *Mutex) ForceRelease()

+ func (m *Mutex) IsLocked() bool

+ func (m *Mutex) SpinLock(step, timeout time.Duration)

+ func (m *Mutex) TryLock() bool

+ func (m *Mutex) TryRelease() bool

+ type Number interface

+ type PairList []SortItemItf

+ func SortBiggest(items PairList) PairList

+ func SortSmallest(items PairList) PairList

+ func (p PairList) Len() int

+ func (p PairList) Less(i, j int) bool

+ func (p PairList) Swap(i, j int)

+ type RBACPermFullKey string

+ func (p RBACPermFullKey) Append(key RBACPermKey) RBACPermFullKey

+ func (p RBACPermFullKey) Contains(acquire RBACPermFullKey) bool

+ func (p RBACPermFullKey) Parent() RBACPermFullKey

+ func (p RBACPermFullKey) String() string

+ type RBACPermKey string

+ func (p RBACPermKey) String() string

+ type RBACPermissionElem struct

+ Children []*RBACPermissionElem

+ FullKey RBACPermFullKey

+ Key RBACPermKey

+ Title string

+ func NewPermissionTree() *RBACPermissionElem

+ func (p *RBACPermissionElem) Clone() *RBACPermissionElem

+ func (p *RBACPermissionElem) Cut(key RBACPermFullKey)

+ func (p *RBACPermissionElem) FillDefault(ancesterKey RBACPermFullKey) error

+ func (p *RBACPermissionElem) GetElemByKey(key RBACPermFullKey) *RBACPermissionElem

+ func (p *RBACPermissionElem) HasPerm(acquiredKey RBACPermFullKey) bool

+ func (p *RBACPermissionElem) Intersection(other *RBACPermissionElem)

+ func (p *RBACPermissionElem) OverwriteBy(another *RBACPermissionElem, intersection bool)

+ func (p *RBACPermissionElem) Scan(input any) error

+ func (p *RBACPermissionElem) UnionAndOverwriteBy(other *RBACPermissionElem)

+ func (p *RBACPermissionElem) Valid() error

+ func (p RBACPermissionElem) Value() (driver.Value, error)

+ type RequestData struct

+ Data any

+ Headers map[string]string

+ type SingleItemExpCache struct

+ func NewSingleItemExpCache(ttl time.Duration) *SingleItemExpCache

+ func (c *SingleItemExpCache) Get() (data any, ok bool)

+ func (c *SingleItemExpCache) GetString() (data string, ok bool)

+ func (c *SingleItemExpCache) GetUintSlice() (data []uint, ok bool)

+ func (c *SingleItemExpCache) Set(data any)

+ type SortItemItf interface

+ GetData func() any

+ GetValue func() int

+ type Sortable interface

+ type StopSignalOptFunc func(*stopSignalOpt)

+ func WithStopSignalCloseSignals(signals ...os.Signal) StopSignalOptFunc

+ type Throttle struct

+ func NewThrottleWithCtx(ctx context.Context, cfg *ThrottleCfg) (t *Throttle, err error)

+ func (t *Throttle) Allow() bool

+ func (t *Throttle) Close()

+ type ThrottleCfg struct

+ Max int

+ NPerSec int

Other modules containing this package

github.com/Laisky/go-utils

github.com/Laisky/go-utils/v2

github.com/Laisky/go-utils/v3

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL