diff --git a/README.md b/README.md index 4a2a2a6..fc02f4d 100644 --- a/README.md +++ b/README.md @@ -703,6 +703,10 @@ import "github.com/duke-git/lancet/v2/mathutil" - **TruncRound** : round off n decimal places for int64. [[doc](https://github.com/duke-git/lancet/blob/main/docs/mathutil.md#TruncRound)] [[play](https://go.dev/play/p/aumarSHIGzP)] +- **Range** : Creates a slice of numbers from start with specified count, element step is 1. + [[doc](https://github.com/duke-git/lancet/blob/main/docs/mathutil.md#Range)] +- **RangeWithStep** : Creates a slice of numbers from start to end with specified step. + [[doc](https://github.com/duke-git/lancet/blob/main/docs/mathutil.md#Range)] ### 13. Netutil package contains functions to get net information and send http request. @@ -916,6 +920,8 @@ import "github.com/duke-git/lancet/v2/slice" - **ForEach** : iterates over elements of slice and invokes function for each element. [[doc](https://github.com/duke-git/lancet/blob/main/docs/slice.md#ForEach)] [[play](https://go.dev/play/p/DrPaa4YsHRF)] +- **ForEachWithBreak** : iterates over elements of slice and invokes function for each element, when iteratee return false, will break the for each loop. + [[doc](https://github.com/duke-git/lancet/blob/main/docs/slice.md#ForEach)] - **GroupBy** : iterate over elements of the slice, each element will be group by criteria, returns two slices. [[doc](https://github.com/duke-git/lancet/blob/main/docs/slice.md#GroupBy)] [[play](https://go.dev/play/p/QVkPxzPR0iA)] @@ -1022,7 +1028,41 @@ import "github.com/duke-git/lancet/v2/slice" [[doc](https://github.com/duke-git/lancet/blob/main/docs/slice.md#KeyBy)] [[play](https://go.dev/play/p/uXod2LWD1Kg)] -### 17. Strutil package contains some functions to manipulate string. + +### 17. Structs package provides several high level functions to manipulate struct, tag, and field. + +```go +import "github.com/duke-git/lancet/v2/structs" +``` + +#### Function list: + +- **New** : creates a `Struct` instance. + [[doc](https://github.com/duke-git/lancet/blob/main/docs/structs/struct.md#New)] +- **ToMap** : converts a valid struct to a map. + [[doc](https://github.com/duke-git/lancet/blob/main/docs/structs/struct.md#ToMap)] +- **Fields** : get all fields of a given struct, that the fields are abstract struct field. + [[doc](https://github.com/duke-git/lancet/blob/main/docs/structs/struct.md#Fields)] +- **IsStruct** : check if the struct is valid. + [[doc](https://github.com/duke-git/lancet/blob/main/docs/structs/struct.md#IsStruct)] +- **Tag** : get a `Tag` of the `Field`, `Tag` is a abstract struct field tag + [[doc](https://github.com/duke-git/lancet/blob/main/docs/structs/field.md#Tag)] +- **Name** : get the field name. + [[doc](https://github.com/duke-git/lancet/blob/main/docs/structs/field.md#Name)] +- **Value** : get the `Field` underlying value. + [[doc](https://github.com/duke-git/lancet/blob/main/docs/structs/field.md#Value)] +- **Kind** : get the field's kind + [[doc](https://github.com/duke-git/lancet/blob/main/docs/structs/field.md#Kind)] +- **IsEmbedded** : check if the field is an embedded field. + [[doc](https://github.com/duke-git/lancet/blob/main/docs/structs/field.md#IsEmbedded)] +- **IsExported** : check if the field is exporte + [[doc](https://github.com/duke-git/lancet/blob/main/docs/structs/field.md#IsExported)] +- **IsZero** : check if the field is zero value + [[doc](https://github.com/duke-git/lancet/blob/main/docs/structs/field.md#IsZero)] +- **IsSlice** : check if the field is a slice + [[doc](https://github.com/duke-git/lancet/blob/main/docs/structs/field.md#IsSlice)] + +### 18. Strutil package contains some functions to manipulate string. ```go import "github.com/duke-git/lancet/v2/strutil" @@ -1135,7 +1175,7 @@ import "github.com/duke-git/lancet/v2/system" [[doc](https://github.com/duke-git/lancet/blob/main/docs/system.md#GetOsBits)] [[play](https://go.dev/play/p/ml-_XH3gJbW)] -### 19. Validator package contains some functions for data validation. +### 20. Validator package contains some functions for data validation. ```go import "github.com/duke-git/lancet/v2/validator" @@ -1228,7 +1268,7 @@ import "github.com/duke-git/lancet/v2/validator" [[doc](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsGBK)] [[play](https://go.dev/play/p/E2nt3unlmzP)] -### 20. xerror package implements helpers for errors. +### 21. xerror package implements helpers for errors. ```go import "github.com/duke-git/lancet/v2/xerror" diff --git a/README_zh-CN.md b/README_zh-CN.md index 3c8578f..a89b72a 100644 --- a/README_zh-CN.md +++ b/README_zh-CN.md @@ -72,7 +72,7 @@ func main() { ## 文档 -### 1. algorithm 包实现一些基本查找和排序算法。 +### 1. algorithm包实现一些基本查找和排序算法。 ```go import "github.com/duke-git/lancet/v2/algorithm" @@ -117,7 +117,7 @@ import "github.com/duke-git/lancet/v2/algorithm" [[doc](https://github.com/duke-git/lancet/blob/main/docs/algorithm_zh-CN.md#LRUCache)] [[play](https://go.dev/play/p/-EZjgOURufP)] -### 2. concurrency 包含一些支持并发编程的功能。例如:goroutine, channel, async 等。 +### 2. concurrency包含一些支持并发编程的功能。例如:goroutine, channel, async 等。 ```go import "github.com/duke-git/lancet/v2/concurrency" @@ -156,7 +156,7 @@ import "github.com/duke-git/lancet/v2/concurrency" [[doc](https://github.com/duke-git/lancet/blob/main/docs/concurrency_zh-CN.md#Tee)] [[play](https://go.dev/play/p/3TQPKnCirrP)] -### 3. condition 包含一些用于条件判断的函数。 +### 3. condition包含一些用于条件判断的函数。 ```go import "github.com/duke-git/lancet/v2/condition" @@ -189,7 +189,7 @@ import "github.com/duke-git/lancet/v2/condition" [[doc](https://github.com/duke-git/lancet/blob/main/docs/condition_zh-CN.md#TernaryOperator)] [[play](https://go.dev/play/p/ElllPZY0guT)] -### 4. convertor 转换器包支持一些常见的数据类型转换。 +### 4. convertor转换器包支持一些常见的数据类型转换。 ```go import "github.com/duke-git/lancet/v2/convertor" @@ -252,7 +252,7 @@ import "github.com/duke-git/lancet/v2/convertor" [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#CopyProperties)] [[play](https://go.dev/play/p/FOVY3XJL-6B)] -### 5. cryptor 加密包支持数据加密和解密,获取 md5,hash 值。支持 base64, md5, hmac, aes, des, rsa。 +### 5. cryptor加密包支持数据加密和解密,获取 md5,hash 值。支持 base64, md5, hmac, aes, des, rsa。 ```go import "github.com/duke-git/lancet/v2/cryptor" @@ -356,7 +356,7 @@ import "github.com/duke-git/lancet/v2/cryptor" [[doc](https://github.com/duke-git/lancet/blob/main/docs/cryptor_zh-CN.md#RsaDecrypt)] [[play](https://go.dev/play/p/uef0q1fz53I)] -### 6. datetime 日期时间处理包,格式化日期,比较日期。 +### 6. datetime日期时间处理包,格式化日期,比较日期。 ```go import "github.com/duke-git/lancet/v2/datetime" @@ -455,7 +455,7 @@ import "github.com/duke-git/lancet/v2/datetime" [[doc](https://github.com/duke-git/lancet/blob/main/docs/datetime_zh-CN.md#ToIso8601)] [[play](https://go.dev/play/p/mkhOHQkdeA2)] -### 7. datastructure 包含一些普通的数据结构实现。例如:list, linklist, stack, queue, set, tree, graph. +### 7. datastructure包含一些普通的数据结构实现。例如:list, linklist, stack, queue, set, tree, graph. ```go import list "github.com/duke-git/lancet/v2/datastructure/list" @@ -487,7 +487,7 @@ import hashmap "github.com/duke-git/lancet/v2/datastructure/hashmap" - **Hashmap** : 哈希映射。 [[doc](https://github.com/duke-git/lancet/blob/main/docs/datastructure/hashmap_zh-CN.md)] -### 8. fileutil 包含文件基本操作。 +### 8. fileutil包含文件基本操作。 ```go import "github.com/duke-git/lancet/v2/fileutil" @@ -541,7 +541,7 @@ import "github.com/duke-git/lancet/v2/fileutil" [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#UnZip)] [[play](https://go.dev/play/p/g0w34kS7B8m)] -### 9. formatter 格式化器包含一些数据格式化处理方法。 +### 9. formatter格式化器包含一些数据格式化处理方法。 ```go import "github.com/duke-git/lancet/v2/formatter" @@ -553,7 +553,7 @@ import "github.com/duke-git/lancet/v2/formatter" [[doc](https://github.com/duke-git/lancet/blob/main/docs/formatter_zh-CN.md#Comma)] [[play](https://go.dev/play/p/eRD5k2vzUVX)] -### 10. function 函数包控制函数执行流程,包含部分函数式编程。 +### 10. function函数包控制函数执行流程,包含部分函数式编程。 ```go import "github.com/duke-git/lancet/v2/function" @@ -589,7 +589,7 @@ import "github.com/duke-git/lancet/v2/function" [[doc](https://github.com/duke-git/lancet/blob/main/docs/function_zh-CN.md#Watcher)] [[play](https://go.dev/play/p/l2yrOpCLd1I)] -### 11. maputil 包括一些操作 map 的函数. +### 11. maputil包括一些操作 map 的函数. ```go import "github.com/duke-git/lancet/v2/maputil" @@ -658,7 +658,7 @@ import "github.com/duke-git/lancet/v2/maputil" [[doc](https://github.com/duke-git/lancet/blob/main/docs/maputil_zh-CN.md#IsDisjoint)] [[play](https://go.dev/play/p/N9qgYg_Ho6f)] -### 12. mathutil 包实现了一些数学计算的函数。 +### 12. mathutil包实现了一些数学计算的函数。 ```go import "github.com/duke-git/lancet/v2/mathutil" @@ -702,8 +702,12 @@ import "github.com/duke-git/lancet/v2/mathutil" - **TruncRound** : 截短 n 位小数(不进行四舍五入)。 [[doc](https://github.com/duke-git/lancet/blob/main/docs/mathutil_zh-CN.md#TruncRound)] [[play](https://go.dev/play/p/aumarSHIGzP)] +- **Range** : 根据指定的起始值和数量,创建一个数字切片。 + [[doc](https://github.com/duke-git/lancet/blob/main/docs/mathutil_zh-CN.md#Range)] +- **RangeWithStep** : 根据指定的起始值,结束值,步长,创建一个数字切片。 + [[doc](https://github.com/duke-git/lancet/blob/main/docs/mathutil_zh-CN.md#RangeWithStep)] -### 13. netutil 网络包支持获取 ip 地址,发送 http 请求。 +### 13. netutil网络包支持获取 ip 地址,发送 http 请求。 ```go import "github.com/duke-git/lancet/v2/netutil" @@ -766,7 +770,7 @@ import "github.com/duke-git/lancet/v2/netutil" - **ParseHttpResponse** : 解析 http 响应体到目标结构体。 [[doc](https://github.com/duke-git/lancet/blob/main/docs/netutil_zh-CN.md#ParseHttpResponse)] -### 14. random 随机数生成器包,可以生成随机[]bytes, int, string。 +### 14. random随机数生成器包,可以生成随机[]bytes, int, string。 ```go import "github.com/duke-git/lancet/v2/random" @@ -799,7 +803,7 @@ import "github.com/duke-git/lancet/v2/random" [[doc](https://github.com/duke-git/lancet/blob/main/docs/random_zh-CN.md#UUIdV4)] [[play](https://go.dev/play/p/_Z9SFmr28ft)] -### 15. retry 重试执行函数直到函数运行成功或被 context cancel。 +### 15. retry重试执行函数直到函数运行成功或被 context cancel。 ```go import "github.com/duke-git/lancet/v2/retry" @@ -823,7 +827,7 @@ import "github.com/duke-git/lancet/v2/retry" [[doc](https://github.com/duke-git/lancet/blob/main/docs/retry_zh-CN.md#RetryTimes)] [[play](https://go.dev/play/p/ssfVeU2SwLO)] -### 16. slice 包含操作切片的方法集合。 +### 16. slice包含操作切片的方法集合。 ```go import "github.com/duke-git/lancet/v2/slice" @@ -915,6 +919,8 @@ import "github.com/duke-git/lancet/v2/slice" - **ForEach** : 遍历切片的元素并为每个元素调用 iteratee 函数。 [[doc](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#ForEach)] [[play](https://go.dev/play/p/DrPaa4YsHRF)] +- **ForEachWithBreak** : 遍历切片的元素并为每个元素调用iteratee函数,当iteratee函数返回false时,终止遍历。 + [[doc](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#ForEachWithBreak)] - **GroupBy** : 迭代切片的元素,每个元素将按条件分组,返回两个切片。 [[doc](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#GroupBy)] [[play](https://go.dev/play/p/QVkPxzPR0iA)] @@ -1021,7 +1027,42 @@ import "github.com/duke-git/lancet/v2/slice" [[doc](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#KeyBy)] [[play](https://go.dev/play/p/uXod2LWD1Kg)] -### 17. strutil 包含字符串处理的相关函数。 +### 17. structs提供操作struct, tag, field的相关函数。 + +```go +import "github.com/duke-git/lancet/v2/structs" +``` + +#### Function list: + +- **New** : `Struct`结构体的构造函数。 + [[doc](https://github.com/duke-git/lancet/blob/main/docs/structs/struct_zh-CN.md#New)] +- **ToMap** : 将一个合法的struct对象转换为map[string]any。 + [[doc](https://github.com/duke-git/lancet/blob/main/docs/structs/struct_zh-CN.md#ToMap)] +- **Fields** : 获取一个struct对象的属性列表。 + [[doc](https://github.com/duke-git/lancet/blob/main/docs/structs/struct_zh-CN.md#Fields)] +- **Field** : 根据属性名获取一个struct对象的属性。 + [[doc](https://github.com/duke-git/lancet/blob/main/docs/structs/struct_zh-CN.md#Fields)] +- **IsStruct** : 判断是否为一个合法的struct对象。 + [[doc](https://github.com/duke-git/lancet/blob/main/docs/structs/struct_zh-CN.md#IsStruct)] +- **Tag** : 获取`Field`的`Tag`,默认的tag key是json。 + [[doc](https://github.com/duke-git/lancet/blob/main/docs/structs/field_zh-CN.md#Tag)] +- **Name** : 获取属性名。 + [[doc](https://github.com/duke-git/lancet/blob/main/docs/structs/field_zh-CN.md#Name)] +- **Value** : 获取`Field`属性的值。 + [[doc](https://github.com/duke-git/lancet/blob/main/docs/structs/field_zh-CN.md#Value)] +- **Kind** : 获取属性Kind。 + [[doc](https://github.com/duke-git/lancet/blob/main/docs/structs/field_zh-CN.md#Kind)] +- **IsEmbedded** : 判断属性是否为嵌入。 + [[doc](https://github.com/duke-git/lancet/blob/main/docs/structs/field_zh-CN.md#IsEmbedded)] +- **IsExported** : 判断属性是否导出。 + [[doc](https://github.com/duke-git/lancet/blob/main/docs/structs/field_zh-CN.md#IsExported)] +- **IsZero** : 判断属性是否为零值。 + [[doc](https://github.com/duke-git/lancet/blob/main/docs/structs/field_zh-CN.md#IsZero)] +- **IsSlice** : 判断属性是否是切片。 + [[doc](https://github.com/duke-git/lancet/blob/main/docs/structs/field_zh-CN.md#IsSlice)] + +### 18. strutil包含字符串处理的相关函数。 ```go import "github.com/duke-git/lancet/v2/strutil" @@ -1100,7 +1141,7 @@ import "github.com/duke-git/lancet/v2/strutil" [[play](https://go.dev/play/p/bj7_odx3vRf)] -### 18. system 包含 os, runtime, shell command 的相关函数。 +### 19. system包含 os, runtime, shell command 的相关函数。 ```go import "github.com/duke-git/lancet/v2/system" @@ -1136,7 +1177,7 @@ import "github.com/duke-git/lancet/v2/system" [[doc](https://github.com/duke-git/lancet/blob/main/docs/system_zh-CN#GetOsBits)] [[play](https://go.dev/play/p/ml-_XH3gJbW)] -### 19. validator 验证器包,包含常用字符串格式验证函数。 +### 20. validator验证器包,包含常用字符串格式验证函数。 ```go import "github.com/duke-git/lancet/v2/validator" @@ -1229,7 +1270,7 @@ import "github.com/duke-git/lancet/v2/validator" [[doc](https://github.com/duke-git/lancet/blob/main/docs/validator_zh-CN.md#IsGBK)] [[play](https://go.dev/play/p/E2nt3unlmzP)] -### 20. xerror 包实现一些错误处理函数 +### 21. xerror包实现一些错误处理函数 ```go import "github.com/duke-git/lancet/v2/xerror" diff --git a/structs/struct.go b/structs/struct.go index 9be9958..8c080d2 100644 --- a/structs/struct.go +++ b/structs/struct.go @@ -1,3 +1,4 @@ +// Package structs provide several high level functions to manipulate struct, tag, and field. package structs import (