From 6d7dec1ceab4b699d8c654966658ce858f348d77 Mon Sep 17 00:00:00 2001 From: dudaodong Date: Sun, 1 Jan 2023 22:00:23 +0800 Subject: [PATCH] doc: update doc for convertor package --- README.md | 64 +++++++++++++++++++++++++++++---------- README_zh-CN.md | 66 ++++++++++++++++++++++++++++++----------- docs/convertor.md | 12 ++++---- docs/convertor_zh-CN.md | 2 +- 4 files changed, 104 insertions(+), 40 deletions(-) diff --git a/README.md b/README.md index 0e55407..be8b6e0 100644 --- a/README.md +++ b/README.md @@ -187,23 +187,55 @@ import "github.com/duke-git/lancet/v2/convertor" ``` #### Function list: +- **ColorHexToRGB** : convert color hex to color rgb. + [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#ColorHexToRGB)] + [[play](https://go.dev/play/p/o7_ft-JCJBV)] +- **ColorRGBToHex** : convert rgb color to hex color. + [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#ColorRGBToHex)] + [[play](https://go.dev/play/p/nzKS2Ro87J1)] +- **ToBool** : convert string to bool. + [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#ToBool)] + [[play](https://go.dev/play/p/ARht2WnGdIN)] +- **ToBytes** : convert value to byte slice. + [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#ToBytes)] + [[play](https://go.dev/play/p/fAMXYFDvOvr)] +- **ToChar** : convert string to char slice. + [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#ToChar)] + [[play](https://go.dev/play/p/JJ1SvbFkVdM)] +- **ToChannel** : convert a collection of elements to a read-only channel. + [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#ToChannel)] + [[play](https://go.dev/play/p/hOx_oYZbAnL)] +- **ToFloat** : convert value to float64, if param is a invalid floatable, will return 0.0 and error. + [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#ToFloat)] + [[play](https://go.dev/play/p/4YTmPCibqHJ)] +- **ToInt** : convert value to int64 value, if input is not numerical, return 0 and error. + [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#ToInt)] + [[play](https://go.dev/play/p/9_h9vIt-QZ_b)] +- **ToJson** : convert value to a json string. + [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#ToJson)] + [[play](https://go.dev/play/p/2rLIkMmXWvR)] +- **ToMap** : convert a slice of structs to a map based on iteratee function. + [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#ToMap)] + [[play](https://go.dev/play/p/tVFy7E-t24l)] +- **ToPointer** : return a pointer of passed value. + [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#ToPointer)] + [[play](https://go.dev/play/p/ASf_etHNlw1)] +- **ToString** : convert value to string. + [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#ToString)] + [[play](https://go.dev/play/p/nF1zOOslpQq)] +- **StructToMap** : convert struct to map, only convert exported struct field. + [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#StructToMap)] + [[play](https://go.dev/play/p/KYGYJqNUBOI)] +- **MapToSlice** : convert map to slice based on iteratee function. + [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#MapToSlice)] + [[play](https://go.dev/play/p/dmX4Ix5V6Wl)] +- **EncodeByte** : encode data to byte slice. + [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#EncodeByte)] + [[play](https://go.dev/play/p/DVmM1G5JfuP)] +- **DecodeByte** : decode byte slice data to target object. + [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#DecodeByte)] + [[play](https://go.dev/play/p/zI6xsmuQRbn)] -- [ColorHexToRGB](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#ColorHexToRGB) -- [ColorRGBToHex](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#ColorRGBToHex) -- [ToBool](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#ToBool) -- [ToBytes](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#ToBytes) -- [ToChar](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#ToChar) -- [ToChannel](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#ToChannel) -- [ToFloat](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#ToFloat) -- [ToInt](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#ToInt) -- [ToJson](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#ToJson) -- [ToMap](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#ToMap) -- [ToPointer](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#ToPointer) -- [ToString](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#ToString) -- [StructToMap](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#StructToMap) -- [MapToSlice](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#MapToSlice) -- [EncodeByte](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#EncodeByte) -- [DecodeByte](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#DecodeByte) ### 5. Cryptor package is for data encryption and decryption. diff --git a/README_zh-CN.md b/README_zh-CN.md index 5767c6a..6097c19 100644 --- a/README_zh-CN.md +++ b/README_zh-CN.md @@ -185,23 +185,55 @@ import "github.com/duke-git/lancet/v2/convertor" ``` #### 函数列表: - -- [ColorHexToRGB](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#ColorHexToRGB) -- [ColorRGBToHex](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#ColorRGBToHex) -- [ToBool](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#ToBool) -- [ToBytes](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#ToBytes) -- [ToChar](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#ToChar) -- [ToChannel](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#ToChannel) -- [ToFloat](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#ToFloat) -- [ToInt](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#ToInt) -- [ToJson](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#ToJson) -- [ToMap](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#ToMap) -- [ToPointer](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#ToPointer) -- [ToString](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#ToString) -- [StructToMap](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#StructToMap) -- [MapToSlice](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#MapToSlice) -- [EncodeByte](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#EncodeByte) -- [DecodeByte](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#DecodeByte) +- **ColorHexToRGB** : 颜色值十六进制转rgb。 + [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#ColorHexToRGB)] + [[play](https://go.dev/play/p/o7_ft-JCJBV)] +- **ColorRGBToHex** : 颜色值rgb转十六进制。 + [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#ColorRGBToHex)] + [[play](https://go.dev/play/p/nzKS2Ro87J1)] +- **ToBool** : 字符串转布尔类型，使用strconv.ParseBool。 + [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#ToBool)] + [[play](https://go.dev/play/p/ARht2WnGdIN)] +- **ToBytes** : interface转字节切片。 + [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#ToBytes)] + [[play](https://go.dev/play/p/fAMXYFDvOvr)] +- **ToChar** : 字符串转字符切片。 + [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#ToChar)] + [[play](https://go.dev/play/p/JJ1SvbFkVdM)] +- **ToChannel** : 将切片转为只读channel。 + [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#ToChannel)] + [[play](https://go.dev/play/p/hOx_oYZbAnL)] +- **ToFloat** : 将interface转成float64类型，如果参数无法转换，会返回0.0和error。 + [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#ToFloat)] + [[play](https://go.dev/play/p/4YTmPCibqHJ)] +- **ToInt** : 将interface转成int64类型，如果参数无法转换，会返回0和error。 + [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#ToInt)] + [[play](https://go.dev/play/p/9_h9vIt-QZ_b)] +- **ToJson** : 将interface转成json字符串，如果参数无法转换，会返回""和error。 + [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#ToJson)] + [[play](https://go.dev/play/p/2rLIkMmXWvR)] +- **ToMap** : 将切片转为map。 + [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#ToMap)] + [[play](https://go.dev/play/p/tVFy7E-t24l)] +- **ToPointer** : 返回传入值的指针。 + [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#ToPointer)] + [[play](https://go.dev/play/p/ASf_etHNlw1)] +- **ToString** : 将值转换为字符串，对于数字、字符串、[]byte，将转换为字符串。 对于其他类型（切片、映射、数组、结构）将调用 json.Marshal。 + [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#ToString)] + [[play](https://go.dev/play/p/nF1zOOslpQq)] +- **StructToMap** : 将struct转成map，只会转换struct中可导出的字段。 + [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#StructToMap)] + [[play](https://go.dev/play/p/KYGYJqNUBOI)] +- **MapToSlice** : map中key和value执行函数iteratee后，转为切片。 + [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#MapToSlice)] + [[play](https://go.dev/play/p/dmX4Ix5V6Wl)] +- **EncodeByte** : 将传入的data编码成字节切片。 + [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#EncodeByte)] + [[play](https://go.dev/play/p/DVmM1G5JfuP)] +- **DecodeByte** : 解码字节切片到目标对象，目标对象需要传入一个指针实例。 + [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#DecodeByte)] + [[play](https://go.dev/play/p/zI6xsmuQRbn)] + ### 5. cryptor 加密包支持数据加密和解密，获取 md5，hash 值。支持 base64, md5, hmac, aes, des, rsa。 diff --git a/docs/convertor.md b/docs/convertor.md index d1544cd..f874f03 100644 --- a/docs/convertor.md +++ b/docs/convertor.md @@ -102,7 +102,7 @@ func main() { ### ToBool -

Convert string to a boolean value. Use strconv.ParseBool

+

Convert string to bool. Use strconv.ParseBool.

Signature: @@ -138,7 +138,7 @@ func main() { ### ToBytes -

Convert interface to byte slice.

+

Convert value to byte slice.

Signature: @@ -200,7 +200,7 @@ func main() { ### ToChannel -

Convert a collection of elements to a read-only channels.

+

Convert a collection of elements to a read-only channel.

Signature: @@ -238,7 +238,7 @@ func main() { ### ToFloat -

Convert interface to a float64 value. If param is a invalid floatable, will return 0 and error.

+

Convert value to a float64 value. If param is a invalid floatable, will return 0.0 and error.

Signature: @@ -271,7 +271,7 @@ func main() { ### ToInt -

Convert interface to a int64 value. If param is a invalid intable, will return 0 and error.

+

Convert value to a int64 value. If param is a invalid intable, will return 0 and error.

Signature: @@ -332,7 +332,7 @@ func main() { ### ToMap -

Convert a slice or an array of structs to a map based on iteratee function.

+

Convert a slice of structs to a map based on iteratee function.

Signature: diff --git a/docs/convertor_zh-CN.md b/docs/convertor_zh-CN.md index 8c185ef..4af1281 100644 --- a/docs/convertor_zh-CN.md +++ b/docs/convertor_zh-CN.md @@ -522,7 +522,7 @@ func main() { ### DecodeByte -

解码字节切片到目标对象，目标对象需要传入一个指针实例子

+

解码字节切片到目标对象，目标对象需要传入一个指针实例

函数签名: