Documentation
¶
Overview ¶
Package gconv implements powerful and convenient converting functionality for any types of variables.
This package should keep much fewer dependencies with other packages.
Index ¶
- func Bool(any interface{}) bool
- func Byte(any interface{}) byte
- func Bytes(any interface{}) []byte
- func Convert(fromValue interface{}, toTypeName string, extraParams ...interface{}) interface{}
- func ConvertGeneric[T any](v interface{}) (result T)
- func Duration(any interface{}) time.Duration
- func Float32(any interface{}) float32
- func Float32s(any interface{}) []float32
- func Float64(any interface{}) float64
- func Float64s(any interface{}) []float64
- func Floats(any interface{}) []float64
- func Int(any interface{}) int
- func Int8(any interface{}) int8
- func Int16(any interface{}) int16
- func Int32(any interface{}) int32
- func Int32s(any interface{}) []int32
- func Int64(any interface{}) int64
- func Int64s(any interface{}) []int64
- func Interfaces(any interface{}) []interface{}
- func Ints(any interface{}) []int
- func LeFillUpSize(b []byte, l int) []byte
- func Map(value interface{}, option ...MapOption) map[string]interface{}
- func MapDeep(value interface{}, tags ...string) map[string]interface{}
- func MapStrStr(value interface{}, option ...MapOption) map[string]string
- func MapStrStrDeep(value interface{}, tags ...string) map[string]string
- func MapToMap(params interface{}, pointer interface{}, mapping ...map[string]string) error
- func MapToMaps(params interface{}, pointer interface{}, mapping ...map[string]string) error
- func Maps(value interface{}, option ...MapOption) []map[string]interface{}
- func MapsDeep(value interface{}, tags ...string) []map[string]interface{}
- func ParseDuration(s string) (duration time.Duration, err error)
- func RegisterConverter(fn interface{}) (err error)
- func Rune(any interface{}) rune
- func Runes(any interface{}) []rune
- func Scan(srcValue interface{}, dstPointer interface{}, ...) (err error)
- func SliceAny[T any](val interface{}) []T
- func SliceFloat(any interface{}) []float64
- func SliceFloat32(any interface{}) []float32
- func SliceFloat64(any interface{}) []float64
- func SliceInt(any interface{}) []int
- func SliceInt32(any interface{}) []int32
- func SliceInt64(any interface{}) []int64
- func SliceMap(any interface{}, option ...MapOption) []map[string]interface{}
- func SliceMapDeep(any interface{}) []map[string]interface{}
- func SliceStr(any interface{}) []string
- func SliceUint(any interface{}) []uint
- func SliceUint32(any interface{}) []uint32
- func SliceUint64(any interface{}) []uint64
- func String(any interface{}) string
- func Strings(any interface{}) []string
- func Struct(params interface{}, pointer interface{}, ...) (err error)
- func StructTag(params interface{}, pointer interface{}, priorityTag string) (err error)
- func Structs(params interface{}, pointer interface{}, mapping ...map[string]string) (err error)
- func StructsTag(params interface{}, pointer interface{}, priorityTag string) (err error)
- func Time(any interface{}, format ...string) time.Time
- func Uint(any interface{}) uint
- func Uint8(any interface{}) uint8
- func Uint16(any interface{}) uint16
- func Uint32(any interface{}) uint32
- func Uint32s(any interface{}) []uint32
- func Uint64(any interface{}) uint64
- func Uint64s(any interface{}) []uint64
- func Uints(any interface{}) []uint
- type IUnmarshalValue
- type MapOption
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Bool ¶
func Bool(any interface{}) bool
Bool converts `any` to bool. It returns false if `any` is: false, "", 0, "false", "off", "no", empty slice/map.
func Convert ¶
func Convert(fromValue interface{}, toTypeName string, extraParams ...interface{}) interface{}
Convert converts the variable `fromValue` to the type `toTypeName`, the type `toTypeName` is specified by string. The optional parameter `extraParams` is used for additional necessary parameter for this conversion. It supports common types conversion as its conversion based on type name string.
func ConvertGeneric ¶
func ConvertGeneric[T any](v interface{}) (result T)
ConvertGeneric converts the variable `v` to a generic type
func Duration ¶
Duration converts `any` to time.Duration. If `any` is string, then it uses time.ParseDuration to convert it. If `any` is numeric, then it converts `any` as nanoseconds.
func Interfaces ¶
func Interfaces(any interface{}) []interface{}
Interfaces converts `any` to []interface{}.
func LeFillUpSize ¶
LeFillUpSize fills up the bytes `b` to given length `l` using LittleEndian.
Note that it creates a new bytes slice by copying the original one to avoid changing the original parameter bytes.
func Map ¶
Map converts any variable `value` to map[string]interface{}. If the parameter `value` is not a map/struct/*struct type, then the conversion will fail and returns nil.
If `value` is a struct/*struct object, the second parameter `priorityTagAndFieldName` specifies the most priority priorityTagAndFieldName that will be detected, otherwise it detects the priorityTagAndFieldName in order of: gconv, json, field name.
func MapDeep ¶
MapDeep does Map function recursively, which means if the attribute of `value` is also a struct/*struct, calls Map function on this attribute converting it to a map[string]interface{} type variable. Deprecated: used Map instead.
func MapStrStr ¶
MapStrStr converts `value` to map[string]string. Note that there might be data copy for this map type converting.
func MapStrStrDeep ¶
MapStrStrDeep converts `value` to map[string]string recursively. Note that there might be data copy for this map type converting. Deprecated: used MapStrStr instead.
func MapToMap ¶
MapToMap converts any map type variable `params` to another map type variable `pointer` using reflect. See doMapToMap.
func MapToMaps ¶
MapToMaps converts any slice type variable `params` to another map slice type variable `pointer`. See doMapToMaps.
func Maps ¶
Maps converts `value` to []map[string]interface{}. Note that it automatically checks and converts json string to []map if `value` is string/[]byte.
func MapsDeep ¶
MapsDeep converts `value` to []map[string]interface{} recursively.
TODO completely implement the recursive converting for all types. Deprecated: used Maps instead.
func ParseDuration ¶
ParseDuration parses a duration string. A duration string is a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms", "-1.5h", "1d" or "2h45m". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h", "d".
Very note that it supports unit "d" more than function time.ParseDuration.
func RegisterConverter ¶ added in v0.9.10
func RegisterConverter(fn interface{}) (err error)
RegisterConverter to register custom converter. It must be registered before you use this custom converting feature. It is suggested to do it in boot procedure of the process.
Note:
- The parameter `fn` must be defined as pattern `func(T1) (T2, error)`. It will convert type `T1` to type `T2`.
- The `T1` should not be type of pointer, but the `T2` should be type of pointer.
func Scan ¶
func Scan(srcValue interface{}, dstPointer interface{}, paramKeyToAttrMap ...map[string]string) (err error)
Scan automatically checks the type of `pointer` and converts `params` to `pointer`. It supports `pointer` in type of `*map/*[]map/*[]*map/*struct/**struct/*[]struct/*[]*struct` for converting.
TODO change `paramKeyToAttrMap` to `ScanOption` to be more scalable; add `DeepCopy` option for `ScanOption`.
func SliceMapDeep ¶
func SliceMapDeep(any interface{}) []map[string]interface{}
SliceMapDeep is alias of MapsDeep. Deprecated: used SliceMap instead.
func String ¶
func String(any interface{}) string
String converts `any` to string. It's most commonly used converting function.
func Struct ¶
func Struct(params interface{}, pointer interface{}, paramKeyToAttrMap ...map[string]string) (err error)
Struct maps the params key-value pairs to the corresponding struct object's attributes. The third parameter `mapping` is unnecessary, indicating the mapping rules between the custom key name and the attribute name(case-sensitive).
Note:
- The `params` can be any type of map/struct, usually a map.
- The `pointer` should be type of *struct/**struct, which is a pointer to struct object or struct pointer.
- Only the public attributes of struct object can be mapped.
- If `params` is a map, the key of the map `params` can be lowercase. It will automatically convert the first letter of the key to uppercase in mapping procedure to do the matching. It ignores the map key, if it does not match.
func StructTag ¶
StructTag acts as Struct but also with support for priority tag feature, which retrieves the specified priorityTagAndFieldName for `params` key-value items to struct attribute names mapping. The parameter `priorityTag` supports multiple priorityTagAndFieldName that can be joined with char ','.
func StructsTag ¶
StructsTag acts as Structs but also with support for priority tag feature, which retrieves the specified tags for `params` key-value items to struct attribute names mapping. The parameter `priorityTag` supports multiple tags that can be joined with char ','.
Types ¶
type IUnmarshalValue ¶ added in v0.9.10
type IUnmarshalValue = localinterface.IUnmarshalValue
IUnmarshalValue is the interface for custom defined types customizing value assignment. Note that only pointer can implement interface IUnmarshalValue.
type MapOption ¶ added in v0.9.10
type MapOption struct {
// Deep marks doing Map function recursively, which means if the attribute of given converting value
// is also a struct/*struct, it automatically calls Map function on this attribute converting it to
// a map[string]interface{} type variable.
Deep bool
// OmitEmpty ignores the attributes that has json `omitempty` tag.
OmitEmpty bool
// Tags specifies the converted map key name by struct tag name.
Tags []string
}
MapOption specifies the option for map converting.
Source Files
¶
- gconv.go
- gconv_convert.go
- gconv_converter.go
- gconv_float.go
- gconv_int.go
- gconv_interface.go
- gconv_map.go
- gconv_maps.go
- gconv_maptomap.go
- gconv_maptomaps.go
- gconv_scan.go
- gconv_slice_any.go
- gconv_slice_float.go
- gconv_slice_int.go
- gconv_slice_str.go
- gconv_slice_uint.go
- gconv_struct.go
- gconv_structs.go
- gconv_time.go
- gconv_uint.go
Directories
¶
| Path | Synopsis |
|---|---|
|
internal
|
|
|
localinterface
Package localinterface defines some interfaces for converting usage.
|
Package localinterface defines some interfaces for converting usage. |
|
structcache
Package structcache provides struct and field info cache feature to enhance performance for struct converting.
|
Package structcache provides struct and field info cache feature to enhance performance for struct converting. |