Documentation
¶
Overview ¶
Package gutil provides utility functions.
Index ¶
- func ComparatorByte(a, b interface{}) int
- func ComparatorFloat32(a, b interface{}) int
- func ComparatorFloat64(a, b interface{}) int
- func ComparatorInt(a, b interface{}) int
- func ComparatorInt16(a, b interface{}) int
- func ComparatorInt32(a, b interface{}) int
- func ComparatorInt64(a, b interface{}) int
- func ComparatorInt8(a, b interface{}) int
- func ComparatorRune(a, b interface{}) int
- func ComparatorString(a, b interface{}) int
- func ComparatorTime(a, b interface{}) int
- func ComparatorUint(a, b interface{}) int
- func ComparatorUint16(a, b interface{}) int
- func ComparatorUint32(a, b interface{}) int
- func ComparatorUint64(a, b interface{}) int
- func ComparatorUint8(a, b interface{}) int
- func Copy(src interface{}) (dst interface{})
- func Dump(values ...interface{})
- func DumpTo(writer io.Writer, value interface{}, option DumpOption)
- func DumpWithOption(value interface{}, option DumpOption)
- func DumpWithType(values ...interface{})
- func GetOrDefaultAny(def interface{}, param ...interface{}) interface{}
- func GetOrDefaultStr(def string, param ...string) string
- func IsEmpty(value interface{}) bool
- func ItemValue(item interface{}, key interface{}) (value interface{}, found bool)
- func Keys(mapOrStruct interface{}) (keysOrAttrs []string)
- func ListItemValues(list interface{}, key interface{}, subKey ...interface{}) (values []interface{})
- func ListItemValuesUnique(list interface{}, key string, subKey ...interface{}) []interface{}
- func ListToMapByKey(list []map[string]interface{}, key string) map[string]interface{}
- func MapContains(data map[string]interface{}, key string) (ok bool)
- func MapContainsPossibleKey(data map[string]interface{}, key string) bool
- func MapCopy(data map[string]interface{}) (copy map[string]interface{})
- func MapDelete(data map[string]interface{}, keys ...string)
- func MapMerge(dst map[string]interface{}, src ...map[string]interface{})
- func MapMergeCopy(src ...map[string]interface{}) (copy map[string]interface{})
- func MapOmitEmpty(data map[string]interface{})
- func MapPossibleItemByKey(data map[string]interface{}, key string) (foundKey string, foundValue interface{})
- func MapToSlice(data interface{}) []interface{}
- func SliceCopy(data []interface{}) []interface{}
- func SliceDelete(data []interface{}, index int) (newSlice []interface{})
- func SliceToMap(slice interface{}) map[string]interface{}
- func SliceToMapWithColumnAsKey(slice interface{}, key interface{}) map[interface{}]interface{}
- func StructToSlice(data interface{}) []interface{}
- func Throw(exception interface{})
- func Try(ctx context.Context, try func(ctx context.Context)) (err error)
- func TryCatch(ctx context.Context, try func(ctx context.Context), ...)
- func Values(mapOrStruct interface{}) (values []interface{})
- type Comparator
- type DumpOption
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ComparatorByte ¶
func ComparatorByte(a, b interface{}) int
ComparatorByte provides a basic comparison on byte.
func ComparatorFloat32 ¶
func ComparatorFloat32(a, b interface{}) int
ComparatorFloat32 provides a basic comparison on float32.
func ComparatorFloat64 ¶
func ComparatorFloat64(a, b interface{}) int
ComparatorFloat64 provides a basic comparison on float64.
func ComparatorInt ¶
func ComparatorInt(a, b interface{}) int
ComparatorInt provides a basic comparison on int.
func ComparatorInt16 ¶
func ComparatorInt16(a, b interface{}) int
ComparatorInt16 provides a basic comparison on int16.
func ComparatorInt32 ¶
func ComparatorInt32(a, b interface{}) int
ComparatorInt32 provides a basic comparison on int32.
func ComparatorInt64 ¶
func ComparatorInt64(a, b interface{}) int
ComparatorInt64 provides a basic comparison on int64.
func ComparatorInt8 ¶
func ComparatorInt8(a, b interface{}) int
ComparatorInt8 provides a basic comparison on int8.
func ComparatorRune ¶
func ComparatorRune(a, b interface{}) int
ComparatorRune provides a basic comparison on rune.
func ComparatorString ¶
func ComparatorString(a, b interface{}) int
ComparatorString provides a fast comparison on strings.
func ComparatorTime ¶
func ComparatorTime(a, b interface{}) int
ComparatorTime provides a basic comparison on time.Time.
func ComparatorUint ¶
func ComparatorUint(a, b interface{}) int
ComparatorUint provides a basic comparison on uint.
func ComparatorUint16 ¶
func ComparatorUint16(a, b interface{}) int
ComparatorUint16 provides a basic comparison on uint16.
func ComparatorUint32 ¶
func ComparatorUint32(a, b interface{}) int
ComparatorUint32 provides a basic comparison on uint32.
func ComparatorUint64 ¶
func ComparatorUint64(a, b interface{}) int
ComparatorUint64 provides a basic comparison on uint64.
func ComparatorUint8 ¶
func ComparatorUint8(a, b interface{}) int
ComparatorUint8 provides a basic comparison on uint8.
func Copy ¶ added in v2.1.0
func Copy(src interface{}) (dst interface{})
Copy returns a deep copy of v.
Copy is unable to copy unexported fields in a struct (lowercase field names). Unexported fields can't be reflected by the Go runtime and therefore they can't perform any data copies.
func Dump ¶
func Dump(values ...interface{})
Dump prints variables `values` to stdout with more manually readable.
func DumpTo ¶
func DumpTo(writer io.Writer, value interface{}, option DumpOption)
DumpTo writes variables `values` as a string in to `writer` with more manually readable
func DumpWithOption ¶
func DumpWithOption(value interface{}, option DumpOption)
DumpWithOption returns variables `values` as a string with more manually readable.
func DumpWithType ¶
func DumpWithType(values ...interface{})
DumpWithType acts like Dump, but with type information. Also see Dump.
func GetOrDefaultAny ¶ added in v2.2.0
func GetOrDefaultAny(def interface{}, param ...interface{}) interface{}
GetOrDefaultAny checks and returns value according whether parameter `param` available. It returns `param[0]` if it is available, or else it returns `def`.
func GetOrDefaultStr ¶ added in v2.2.0
GetOrDefaultStr checks and returns value according whether parameter `param` available. It returns `param[0]` if it is available, or else it returns `def`.
func IsEmpty ¶
func IsEmpty(value interface{}) bool
IsEmpty checks given `value` empty or not. It returns false if `value` is: integer(0), bool(false), slice/map(len=0), nil; or else returns true.
func ItemValue ¶
func ItemValue(item interface{}, key interface{}) (value interface{}, found bool)
ItemValue retrieves and returns its value of which name/attribute specified by `key`. The parameter `item` can be type of map/*map/struct/*struct.
func Keys ¶
func Keys(mapOrStruct interface{}) (keysOrAttrs []string)
Keys retrieves and returns the keys from given map or struct.
func ListItemValues ¶
func ListItemValues(list interface{}, key interface{}, subKey ...interface{}) (values []interface{})
ListItemValues retrieves and returns the elements of all item struct/map with key `key`. Note that the parameter `list` should be type of slice which contains elements of map or struct, or else it returns an empty slice.
The parameter `list` supports types like: []map[string]interface{} []map[string]sub-map []struct []struct:sub-struct Note that the sub-map/sub-struct makes sense only if the optional parameter `subKey` is given.
func ListItemValuesUnique ¶
func ListItemValuesUnique(list interface{}, key string, subKey ...interface{}) []interface{}
ListItemValuesUnique retrieves and returns the unique elements of all struct/map with key `key`. Note that the parameter `list` should be type of slice which contains elements of map or struct, or else it returns an empty slice.
func ListToMapByKey ¶
ListToMapByKey converts `list` to a map[string]interface{} of which key is specified by `key`. Note that the item value may be type of slice.
func MapContains ¶
MapContains checks whether map `data` contains `key`.
func MapContainsPossibleKey ¶
MapContainsPossibleKey checks if the given `key` is contained in given map `data`. It checks the key ignoring cases and symbols.
Note that this function might be of low performance.
func MapCopy ¶
MapCopy does a shallow copy from map `data` to `copy` for most commonly used map type map[string]interface{}.
func MapMergeCopy ¶
MapMergeCopy creates and returns a new map which merges all map from `src`.
func MapOmitEmpty ¶
func MapOmitEmpty(data map[string]interface{})
MapOmitEmpty deletes all empty values from given map.
func MapPossibleItemByKey ¶
func MapPossibleItemByKey(data map[string]interface{}, key string) (foundKey string, foundValue interface{})
MapPossibleItemByKey tries to find the possible key-value pair for given key ignoring cases and symbols.
Note that this function might be of low performance.
func MapToSlice ¶
func MapToSlice(data interface{}) []interface{}
MapToSlice converts map to slice of which all keys and values are its items. Eg: {"K1": "v1", "K2": "v2"} => ["K1", "v1", "K2", "v2"]
func SliceCopy ¶
func SliceCopy(data []interface{}) []interface{}
SliceCopy does a shallow copy of slice `data` for most commonly used slice type []interface{}.
func SliceDelete ¶
func SliceDelete(data []interface{}, index int) (newSlice []interface{})
SliceDelete deletes an element at `index` and returns the new slice. It does nothing if the given `index` is invalid.
func SliceToMap ¶
func SliceToMap(slice interface{}) map[string]interface{}
SliceToMap converts slice type variable `slice` to `map[string]interface{}`. Note that if the length of `slice` is not an even number, it returns nil. Eg: ["K1", "v1", "K2", "v2"] => {"K1": "v1", "K2": "v2"} ["K1", "v1", "K2"] => nil
func SliceToMapWithColumnAsKey ¶
func SliceToMapWithColumnAsKey(slice interface{}, key interface{}) map[interface{}]interface{}
SliceToMapWithColumnAsKey converts slice type variable `slice` to `map[interface{}]interface{}` The value of specified column use as the key for returned map. Eg: SliceToMapWithColumnAsKey([{"K1": "v1", "K2": 1}, {"K1": "v2", "K2": 2}], "K1") => {"v1": {"K1": "v1", "K2": 1}, "v2": {"K1": "v2", "K2": 2}} SliceToMapWithColumnAsKey([{"K1": "v1", "K2": 1}, {"K1": "v2", "K2": 2}], "K2") => {1: {"K1": "v1", "K2": 1}, 2: {"K1": "v2", "K2": 2}}
func StructToSlice ¶
func StructToSlice(data interface{}) []interface{}
StructToSlice converts struct to slice of which all keys and values are its items. Eg: {"K1": "v1", "K2": "v2"} => ["K1", "v1", "K2", "v2"]
func Throw ¶
func Throw(exception interface{})
Throw throws out an exception, which can be caught be TryCatch or recover.
func Try ¶
Try implements try... logistics using internal panic...recover. It returns error if any exception occurs, or else it returns nil.
func TryCatch ¶
func TryCatch(ctx context.Context, try func(ctx context.Context), catch ...func(ctx context.Context, exception error))
TryCatch implements try...catch... logistics using internal panic...recover. It automatically calls function `catch` if any exception occurs and passes the exception as an error.
Types ¶
type Comparator ¶
type Comparator func(a, b interface{}) int
Comparator is a function that compare a and b, and returns the result as int.
Should return a number:
negative , if a < b zero , if a == b positive , if a > b
type DumpOption ¶
type DumpOption struct {
WithType bool // WithType specifies dumping content with type information.
ExportedOnly bool // Only dump Exported fields for structs.
}
DumpOption specifies the behavior of function Export.
Source Files