utils

package
v0.14.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 9, 2024 License: BSD-3-Clause Imports: 23 Imported by: 19

README

Utils

This package contains a good few number of helper functions which are commonly used in projects. We used some of them in RonyKIT internally and exposed them in this separate package to let other projects use it easily.

Some utilities this package provides:

  1. Random generators for String, Digits, ...
  2. SpinLock: a mutex-free lock
  3. Strings: transformation helper functions such as ToCamel, ToLowerCamel, ...
  4. LinkedList
  5. Hash: optimized version of Sha512 and Sha256 implementations of builtin hash functions.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func AddUnique added in v0.11.39 

func AddUnique[T comparable](s []T, v T) []T

func AppendStrInt 

func AppendStrInt(sb *strings.Builder, x int)

func AppendStrInt32 

func AppendStrInt32(sb *strings.Builder, x int32)

func AppendStrInt64 

func AppendStrInt64(sb *strings.Builder, x int64)

func AppendStrUInt 

func AppendStrUInt(sb *strings.Builder, x uint)

func AppendStrUInt32 

func AppendStrUInt32(sb *strings.Builder, x uint32)

func AppendStrUInt64 

func AppendStrUInt64(sb *strings.Builder, x uint64)

func ArrayToMap added in v0.11.30 

func ArrayToMap[V any](s []V) map[int]V

ArrayToMap converts a slice to a map with the index as the key.

func ArrayToSet added in v0.11.41 

func ArrayToSet[T comparable](s []T) map[T]struct{}

func B2S 

func B2S(bts []byte) string

B2S is alias for ByteToStr.

func ByteToStr 

func ByteToStr(bts []byte) string

ByteToStr converts byte slice to a string without memory allocation. Note it may break if string and/or slice header will change in the future go versions.

func CPUTicks 

func CPUTicks() int64

CPUTicks is a faster alternative to NanoTime to measure time duration.

func CloneBytes added in v0.10.24 

func CloneBytes(b []byte) []byte

func CloneStr added in v0.10.24 

func CloneStr(s string) string

func Contains added in v0.11.30 

func Contains[T comparable](s []T, v T) bool

func ContainsAll added in v0.11.30 

func ContainsAll[T comparable](s []T, v []T) bool

func ContainsAny added in v0.11.30 

func ContainsAny[T comparable](s []T, v []T) bool

func CopyFile added in v0.10.19 

func CopyFile(srcFile, dstFile string) error

func CopyFileWithBuffer added in v0.10.19 

func CopyFileWithBuffer(srcFile, dstFile string, buf []byte) error

func F32ToStr added in v0.11.30 

func F32ToStr(x float32) string

func F64ToStr added in v0.11.30 

func F64ToStr(x float64) string

func FastRand 

func FastRand() uint32

FastRand is a fast thread local random function.

func Filter added in v0.11.17 

func Filter[T any](match func(src T) bool, tt []T) []T

Filter returns a new slice containing only the elements in tt for which the match function returns true. 

	type User struct {
		Name string
		Age  int
		Active bool
}

var users = []User{
	{"Tom", 20, true},
	{"Jack", 22, false},
	{"Mary", 18, true},
}

var activeUsers = qkit.Filter(func(u User) bool {
	return u.Active
}, users)

fmt.Println(activeUsers)

Playground: https://go.dev/play/p/70YOKRs79OF

func First added in v0.11.30 

func First[K, V comparable](in map[K]V, keys ...K) (V, bool)

First returns the first value found in the map for the given keys.

func FirstOr added in v0.11.30 

func FirstOr[K, V comparable](def V, in map[K]V, keys ...K) V

func Float32ToStr added in v0.10.24 

func Float32ToStr(x float32) string

func Float64ToStr added in v0.10.24 

func Float64ToStr(x float64) string

func ForEach added in v0.11.32 

func ForEach[V any](in []V, fn func(*V))

func GetExecDir added in v0.10.19 

func GetExecDir() string

func GetExecName added in v0.10.19 

func GetExecName() string

func Int32ToStr 

func Int32ToStr(x int32) string

func Int64ToStr 

func Int64ToStr(x int64) string

func IntToStr 

func IntToStr(x int) string

func Map added in v0.11.17 

func Map[S, D any](transformer func(src S) D, ss []S) []D

Map applies the transformer function to each element of the slice ss. The result is a slice of the same length as ss, where the kth element is transformer(ss[k]). 

type User struct {
	Name string
	Age  int
}

var users = []User{
	{"Tom", 20},
	{"Jack", 22},
	{"Mary", 18},
}

var names = qkit.Map(func(u User) string {
	return u.Name
}, users)

fmt.Println(names)

Playground: https://go.dev/play/p/wKIa32-rMDn

func MapKeysToArray added in v0.11.41 

func MapKeysToArray[K comparable, V any](s map[K]V) []K

MapKeysToArray converts a map's keys to a slice.

func MapToArray added in v0.11.17 

func MapToArray[K comparable, V any](s map[K]V) []V

MapToArray converts a map's values to a slice.

func Must added in v0.11.19 

func Must[T any](src T, err error) T

Must panics if err is not nil

func MustSha256 

func MustSha256(in, out []byte) []byte

func MustSha512 

func MustSha512(in, out []byte) []byte

MustSha512 is Sha512 but it panics if any error happens

func NanoTime 

func NanoTime() int64

NanoTime returns the current time in nanoseconds from a monotonic clock.

func Ok added in v0.11.30 

func Ok[T any](v T, _ error) T

Ok returns the value and ignores the error

func OkOr added in v0.11.30 

func OkOr[T any](v T, err error, fallback T) T

OkOr returns the value if err is nil, otherwise returns the fallback value

func Paginate added in v0.11.17 

func Paginate[T any](arr []T, pageSize int, fn func(start, end int) error) error

Paginate will call the given function with start and end indexes for a slice of the given size. 

type User struct {
	Name string
	Age  int
}

var users = []User{
	{"Tom", 20},
	{"Jack", 22},
	{"Mary", 18},
	{"Tommy", 20},
	{"Lin", 22},
}

qkit.Paginate(users, 2, func(start, end int) error {
	fmt.Println(users[start:end])
	return nil
})

Playground: https://go.dev/play/p/aDiVJEKjgwW

func PtrVal added in v0.11.17 

func PtrVal[T any](src *T) T

PtrVal returns the value of the pointer src. It is a dereference operation.

func RandomDigit 

func RandomDigit(n int) string

RandomDigit generates a pseudo-random string with length 'n' which characters are only digits (0-9)

func RandomID 

func RandomID(n int) string

RandomID generates a pseudo-random string with length 'n' which characters are alphanumerics.

func RandomIDs 

func RandomIDs(n ...int) []string

func RandomInt 

func RandomInt(n int) (x int)

func RandomInt32 

func RandomInt32(n int32) (x int32)

RandomInt32 produces a pseudo-random 31bit number, if n == 0 there will be no limit otherwise the output will be smaller than n

func RandomInt64 

func RandomInt64(n int64) (x int64)

RandomInt64 produces a pseudo-random 63bit number, if n == 0 there will be no limit otherwise the output will be smaller than n

func RandomUint64 

func RandomUint64(n uint64) (x uint64)

RandomUint64 produces a pseudo-random unsigned number

func ReadYamlFile added in v0.10.19 

func ReadYamlFile(filePath string, data any) error

func Reduce added in v0.11.17 

func Reduce[T, R any](reducer func(r R, t T) R, tt []T) R

Reduce [T, R] reduces the slice tt to a single value r using the reducer function. The reducer function takes the current reduced value r and the current slice value t and returns a new reduced value. 

type User struct {
	Name string
	Age  int
}

var users = []User{
	{"Tom", 20},
	{"Jack", 22},
	{"Mary", 18},
}

var totalAge = qkit.Reduce(func(r int, u User) int {
	return r + u.Age
}, users)

fmt.Println(totalAge)

Playground: https://go.dev/play/p/gf9evzMIMIK

func S2B 

func S2B(str string) []byte

S2B is alias for StrToByte.

func SecureRandomInt63 

func SecureRandomInt63(n int64) (x int64)

SecureRandomInt63 produces a secure pseudo-random 63bit number

func SecureRandomUint64 

func SecureRandomUint64() (x uint64)

SecureRandomUint64 produces a secure pseudo-random 64bit number

func Sha256 

func Sha256(in, out []byte) ([]byte, error)

Sha256 appends a 32bytes array which is sha256(in) to out

func Sha512 

func Sha512(in, out []byte) ([]byte, error)

Sha512 appends a 64bytes array which is sha512(in) to out and returns out

func StrToByte 

func StrToByte(str string) (b []byte)

StrToByte converts string to a byte slice without memory allocation. Note it may break if string and/or slice header will change in the future go versions.

func StrToFloat32 

func StrToFloat32(s string) float32

func StrToFloat64 

func StrToFloat64(s string) float64

func StrToInt 

func StrToInt(s string) int

func StrToInt32 

func StrToInt32(s string) int32

func StrToInt64 

func StrToInt64(s string) int64

func StrToUInt 

func StrToUInt(s string) uint

func StrToUInt32 

func StrToUInt32(s string) uint32

func StrToUInt64 

func StrToUInt64(s string) uint64

func StrTruncate added in v0.9.26 

func StrTruncate(s string, maxSize int) string

func TimeUnix 

func TimeUnix() int64

func TimeUnixSubtract 

func TimeUnixSubtract(unixTime int64, d time.Duration) int64

func ToCamel 

func ToCamel(s string) string

ToCamel converts a string to CamelCase

func ToDelimited 

func ToDelimited(s string, delimiter uint8) string

ToDelimited converts a string to delimited.snake.case (in this case `delimiter = '.'`)

func ToKebab 

func ToKebab(s string) string

ToKebab converts a string to kebab-case

func ToLowerCamel 

func ToLowerCamel(s string) string

ToLowerCamel converts a string to lowerCamelCase

func ToScreamingDelimited 

func ToScreamingDelimited(s string, delimiter uint8, ignore uint8, screaming bool) string

ToScreamingDelimited converts a string to SCREAMING.DELIMITED.SNAKE.CASE (in this case `delimiter = '.'; screaming = true`) or delimited.snake.case (in this case `delimiter = '.'; screaming = false`)

func ToScreamingKebab 

func ToScreamingKebab(s string) string

ToScreamingKebab converts a string to SCREAMING-KEBAB-CASE

func ToScreamingSnake 

func ToScreamingSnake(s string) string

ToScreamingSnake converts a string to SCREAMING_SNAKE_CASE

func ToSnake 

func ToSnake(s string) string

ToSnake converts a string to snake_case

func ToSnakeWithIgnore 

func ToSnakeWithIgnore(s string, ignore uint8) string

func UInt32ToStr 

func UInt32ToStr(x uint32) string

func UInt64ToStr 

func UInt64ToStr(x uint64) string

func UIntToStr added in v0.11.30 

func UIntToStr(x uint) string

func ValPtr added in v0.11.17 

func ValPtr[T any](src T) *T

ValPtr returns the pointer of the src. It is a reference operation.

func ValPtrOrNil added in v0.11.17 

func ValPtrOrNil[T comparable](src T) *T

ValPtrOrNil returns the pointer of the src if src is not zero value, otherwise nil.

func VisitAll added in v0.11.30 

func VisitAll[VisitorState any](
	initial VisitorState,
	visitors ...func(ctx *VisitorState),
) VisitorState

VisitAll runs all visitors and returns the final state

func VisitCond added in v0.11.30 

func VisitCond[VisitorState any](
	initial VisitorState,
	cond func(ctx *VisitorState) bool,
	visitors ...func(ctx *VisitorState),
) VisitorState

VisitCond runs all visitors if the condition is true and returns the final state If the condition is false, the visitor will stop and DO NOT run the rest of the visitors. cond function is called before each visitor.

NOTE: `cond` is called before each visitor, hence, it will be run on initial state too.

func VisitStopOnErr added in v0.11.30 

func VisitStopOnErr[VisitorState any](
	initial VisitorState,
	visitors ...func(ctx *VisitorState) error,
) (VisitorState, error)

VisitStopOnErr runs all visitors and returns the final state If any of the visitors returns an error, the visitor will stop and DO NOT run the rest of the visitors. It returns the latest state and the error.

func WriteYamlFile added in v0.10.19 

func WriteYamlFile(filePath string, data any) error

Types

type LinkedList 

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

func NewLinkedList 

func NewLinkedList() *LinkedList

func (*LinkedList) Append 

func (ll *LinkedList) Append(data any)

func (*LinkedList) Get 

func (ll *LinkedList) Get(index int32) (n *Node)

func (*LinkedList) Head 

func (ll *LinkedList) Head() *Node

func (*LinkedList) PickHeadData 

func (ll *LinkedList) PickHeadData() any

func (*LinkedList) PickTailData 

func (ll *LinkedList) PickTailData() any

func (*LinkedList) Prepend 

func (ll *LinkedList) Prepend(data any)

func (*LinkedList) RemoveAt 

func (ll *LinkedList) RemoveAt(index int32)

func (*LinkedList) Reset 

func (ll *LinkedList) Reset()

func (*LinkedList) Size 

func (ll *LinkedList) Size() int32

func (*LinkedList) String 

func (ll *LinkedList) String() string

func (*LinkedList) Tail 

func (ll *LinkedList) Tail() *Node

type Node 

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

func (Node) GetData 

func (n Node) GetData() any

type Numeric added in v0.9.13 

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

Numeric represents float64 number which is decodable from string, int or float. It's useful when a struct field should be numeric but form of the data being decoded from is unknown or variable.

func ParseNumeric added in v0.9.13 

func ParseNumeric(src any) Numeric

ParseNumeric converts int, string, float to Numeric.

func (Numeric) MarshalJSON added in v0.10.27 

func (n Numeric) MarshalJSON() ([]byte, error)

func (Numeric) String added in v0.9.13 

func (n Numeric) String() string

func (*Numeric) UnmarshalJSON added in v0.9.13 

func (n *Numeric) UnmarshalJSON(bb []byte) error

func (Numeric) Value added in v0.9.13 

func (n Numeric) Value() float64

func (Numeric) WithPrecision added in v0.9.13 

func (n Numeric) WithPrecision(p int) Numeric

func (Numeric) WithoutPrecision added in v0.9.13 

func (n Numeric) WithoutPrecision() Numeric

type Result added in v0.11.23 

type Result struct {
	Val    any
	Err    error
	Shared bool
}

Result holds the results of Do, so they can be passed on a channel.

type SingleFlightCall added in v0.11.23 

type SingleFlightCall[T any] func(fn func() (T, error)) (T, error)

func SingleFlight added in v0.11.23 

func SingleFlight[T any]() SingleFlightCall[T]

SingleFlight executes and returns the results of the given function, making sure that only one execution is in-flight for a given key at a time. If a duplicate comes in, the duplicate caller waits for the original to complete and receives the same results. The return value shared indicates whether v was given to multiple cal

type SpinLock 

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

SpinLock is a spinlock implementation.

A SpinLock must not be copied after first use. This SpinLock intended to be used to synchronize exceptionally short-lived operations.

func (*SpinLock) Lock 

func (l *SpinLock) Lock()

Lock locks l. If the lock is already in use, the calling goroutine blocks until the locker is available.

func (*SpinLock) Unlock 

func (l *SpinLock) Unlock()

Unlock unlocks l.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.