From c5e6d01a31da1a8a961f933628ac9500d954bea8 Mon Sep 17 00:00:00 2001 From: dudaodong Date: Mon, 29 Aug 2022 11:50:37 +0800 Subject: [PATCH] update readme file: add new package and function --- README.md | 55 ++++++++++++++++++++++++++++++++----------------- README_zh-CN.md | 54 ++++++++++++++++++++++++++++++++---------------- 2 files changed, 72 insertions(+), 37 deletions(-) diff --git a/README.md b/README.md index 07ca8df..71a09bb 100644 --- a/README.md +++ b/README.md @@ -107,7 +107,22 @@ import "github.com/duke-git/lancet/v2/concurrency" - [Take](https://github.com/duke-git/lancet/blob/main/docs/concurrency.md#Take) - [Tee](https://github.com/duke-git/lancet/blob/main/docs/concurrency.md#Tee) -### 3. Convertor package contains some functions for data convertion. + +### 3. Condition package contains some functions for conditional judgment. eg. And, Or, TernaryOperator... + +```go +import "github.com/duke-git/lancet/v2/condition" +``` +#### Function list: +- [Bool](https://github.com/duke-git/lancet/blob/main/docs/condition.md#Bool) +- [And](https://github.com/duke-git/lancet/blob/main/docs/condition.md#And) +- [Or](https://github.com/duke-git/lancet/blob/main/docs/condition.md#Or) +- [Xor](https://github.com/duke-git/lancet/blob/main/docs/condition.md#Xor) +- [Nor](https://github.com/duke-git/lancet/blob/main/docs/condition.md#Nor) +- [Nand](https://github.com/duke-git/lancet/blob/main/docs/condition.md#Nand) +- [TernaryOperator](https://github.com/duke-git/lancet/blob/main/docs/condition.md#TernaryOperator) + +### 4. Convertor package contains some functions for data convertion. ```go import "github.com/duke-git/lancet/v2/convertor" @@ -127,8 +142,10 @@ import "github.com/duke-git/lancet/v2/convertor" - [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) -### 4. Cryptor package is for data encryption and decryption. +### 5. Cryptor package is for data encryption and decryption. ```go import "github.com/duke-git/lancet/v2/cryptor" @@ -168,7 +185,7 @@ import "github.com/duke-git/lancet/v2/cryptor" - [RsaEncrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#RsaEncrypt) - [RsaDecrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#RsaDecrypt) -### 5. Datetime package supports date and time format and compare. +### 6. Datetime package supports date and time format and compare. ```go @@ -208,7 +225,7 @@ import "github.com/duke-git/lancet/v2/datetime" -### 6. Datastructure package constains some common data structure. eg. list, linklist, stack, queue, set, tree, graph. +### 7. Datastructure package constains some common data structure. eg. list, linklist, stack, queue, set, tree, graph. ```go @@ -232,7 +249,7 @@ import hashmap "github.com/duke-git/lancet/v2/datastructure/hashmap" - [HashMap](https://github.com/duke-git/lancet/blob/main/docs/datastructure/hashmap.md) -### 7. Fileutil package implements some basic functions for file operations. +### 8. Fileutil package implements some basic functions for file operations. ```go import "github.com/duke-git/lancet/v2/fileutil" @@ -256,7 +273,7 @@ import "github.com/duke-git/lancet/v2/fileutil" - [Zip](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#Zip) - [UnZip](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#UnZip) -### 8. Formatter contains some functions for data formatting. +### 9. Formatter contains some functions for data formatting. ```go import "github.com/duke-git/lancet/v2/formatter" @@ -264,7 +281,7 @@ import "github.com/duke-git/lancet/v2/formatter" #### Function list: - [Comma](https://github.com/duke-git/lancet/blob/main/docs/formatter.md#Comma) -### 9. Function package can control the flow of function execution and support part of functional programming +### 10. Function package can control the flow of function execution and support part of functional programming ```go import "github.com/duke-git/lancet/v2/function" @@ -280,7 +297,7 @@ import "github.com/duke-git/lancet/v2/function" - [Watcher](https://github.com/duke-git/lancet/blob/main/docs/function.md#Watcher) -### 10. Maputil package includes some functions to manipulate map. +### 11. Maputil package includes some functions to manipulate map. ```go import "github.com/duke-git/lancet/v2/maputil" @@ -297,7 +314,7 @@ import "github.com/duke-git/lancet/v2/maputil" - [IsDisjoint](https://github.com/duke-git/lancet/blob/main/docs/maputil.md#IsDisjoint) -### 11. Mathutil package implements some functions for math calculation. +### 12. Mathutil package implements some functions for math calculation. ```go import "github.com/duke-git/lancet/v2/mathutil" @@ -318,7 +335,7 @@ import "github.com/duke-git/lancet/v2/mathutil" - [TruncRound](https://github.com/duke-git/lancet/blob/main/docs/mathutil.md#TruncRound) -### 12. Netutil package contains functions to get net information and send http request. +### 13. Netutil package contains functions to get net information and send http request. ```go import "github.com/duke-git/lancet/v2/netutil" @@ -326,14 +343,14 @@ import "github.com/duke-git/lancet/v2/netutil" #### Function list: - [ConvertMapToQueryString](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#ConvertMapToQueryString) -- [EncodeUrl](https://github.com/duke-git/lancet/blob/main/docs/netutil_zh-CN.md#EncodeUrl) +- [EncodeUrl](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#EncodeUrl) - [GetInternalIp](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#GetInternalIp) - [GetIps](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#GetIps) - [GetMacAddrs](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#GetMacAddrs) - [GetPublicIpInfo](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#GetPublicIpInfo) - [GetRequestPublicIp](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#GetRequestPublicIp) - [IsPublicIP](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#IsPublicIP) -- [IsInternalIP](https://github.com/duke-git/lancet/blob/main/docs/netutil_zh-CN.md#IsInternalIP) +- [IsInternalIP](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#IsInternalIP) - [HttpGet](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#HttpGet) - [HttpDelete](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#HttpDelete) - [HttpPost](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#HttpPost) @@ -341,7 +358,7 @@ import "github.com/duke-git/lancet/v2/netutil" - [HttpPatch](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#HttpPatch) - [ParseHttpResponse](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#ParseHttpResponse) -### 13. Random package implements some basic functions to generate random int and string. +### 14. Random package implements some basic functions to generate random int and string. ```go import "github.com/duke-git/lancet/v2/random" @@ -353,7 +370,7 @@ import "github.com/duke-git/lancet/v2/random" - [RandString](https://github.com/duke-git/lancet/blob/main/docs/random.md#RandString) - [UUIdV4](https://github.com/duke-git/lancet/blob/main/docs/random.md#UUIdV4) -### 14. Retry package is for executing a function repeatedly until it was successful or canceled by the context. +### 15. Retry package is for executing a function repeatedly until it was successful or canceled by the context. ```go import "github.com/duke-git/lancet/v2/retry" @@ -366,7 +383,7 @@ import "github.com/duke-git/lancet/v2/retry" - [RetryDuration](https://github.com/duke-git/lancet/blob/main/docs/retry.md#RetryDuration) - [RetryTimes](https://github.com/duke-git/lancet/blob/main/docs/retry.md#RetryTimes) -### 15. Slice contains some functions to manipulate slice. +### 16. Slice contains some functions to manipulate slice. ```go import "github.com/duke-git/lancet/v2/slice" @@ -418,7 +435,7 @@ import "github.com/duke-git/lancet/v2/slice" - [UpdateAt](https://github.com/duke-git/lancet/blob/main/docs/slice.md#UpdateAt) - [Without](https://github.com/duke-git/lancet/blob/main/docs/slice.md#Without) -### 16. Strutil package contains some functions to manipulate string. +### 17. Strutil package contains some functions to manipulate string. ```go import "github.com/duke-git/lancet/v2/strutil" ``` @@ -443,7 +460,7 @@ import "github.com/duke-git/lancet/v2/strutil" - [Wrap](https://github.com/duke-git/lancet/blob/main/docs/strutil.md#Wrap) - [Unwrap](https://github.com/duke-git/lancet/blob/main/docs/strutil.md#Unwrap) -### 17. System package contain some functions about os, runtime, shell command. +### 19. System package contain some functions about os, runtime, shell command. ```go import "github.com/duke-git/lancet/v2/system" @@ -459,7 +476,7 @@ import "github.com/duke-git/lancet/v2/system" - [ExecCommand](https://github.com/duke-git/lancet/blob/main/docs/system.md#ExecCommand) - [GetOsBits](https://github.com/duke-git/lancet/blob/main/docs/system.md#GetOsBits) -### 18. Validator package contains some functions for data validation. +### 19. Validator package contains some functions for data validation. ```go import "github.com/duke-git/lancet/v2/validator" @@ -494,7 +511,7 @@ import "github.com/duke-git/lancet/v2/validator" - [IsUrl](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsUrl) - [IsWeakPassword](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsWeakPassword) - [IsZeroValue](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsZeroValue) -### 19. xerror package implements helpers for errors. +### 20. 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 cf0d06e..134c99c 100644 --- a/README_zh-CN.md +++ b/README_zh-CN.md @@ -89,7 +89,7 @@ import "github.com/duke-git/lancet/v2/algorithm" - [LRUCache](https://github.com/duke-git/lancet/blob/main/docs/algorithm_zh-CN.md#LRUCache) -### 2. 并发包包含一些支持并发编程的功能。例如:goroutine, channel, async等。 +### 2. concurrency并发包包含一些支持并发编程的功能。例如:goroutine, channel, async等。 ```go import "github.com/duke-git/lancet/v2/concurrency" @@ -105,8 +105,23 @@ import "github.com/duke-git/lancet/v2/concurrency" - [RepeatFn](https://github.com/duke-git/lancet/blob/main/docs/concurrency_zh-CN.md#RepeatFn) - [Take](https://github.com/duke-git/lancet/blob/main/docs/concurrency_zh-CN.md#Take) - [Tee](https://github.com/duke-git/lancet/blob/main/docs/concurrency_zh-CN.md#Tee) + + +### 3. condition条件包含一些用于条件判断的函数。eg. And, Or, TernaryOperator... + +```go +import "github.com/duke-git/lancet/v2/condition" +``` +#### Function list: +- [Bool](https://github.com/duke-git/lancet/blob/main/docs/condition_zh-CN.md#Bool) +- [And](https://github.com/duke-git/lancet/blob/main/docs/condition_zh-CN.md#And) +- [Or](https://github.com/duke-git/lancet/blob/main/docs/condition_zh-CN.md#Or) +- [Xor](https://github.com/duke-git/lancet/blob/main/docs/condition_zh-CN.md#Xor) +- [Nor](https://github.com/duke-git/lancet/blob/main/docs/condition_zh-CN.md#Nor) +- [Nand](https://github.com/duke-git/lancet/blob/main/docs/condition_zh-CN.md#Nand) +- [TernaryOperator](https://github.com/duke-git/lancet/blob/main/docs/condition_zh-CN.md#TernaryOperator) -### 3. convertor转换器包支持一些常见的数据类型转换。 +### 4. convertor转换器包支持一些常见的数据类型转换。 ```go import "github.com/duke-git/lancet/v2/convertor" @@ -126,7 +141,10 @@ import "github.com/duke-git/lancet/v2/convertor" - [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) -### 4. cryptor加密包支持数据加密和解密,获取md5,hash值。支持base64, md5, hmac, aes, des, rsa。 +- [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) + +### 5. cryptor加密包支持数据加密和解密,获取md5,hash值。支持base64, md5, hmac, aes, des, rsa。 ```go import "github.com/duke-git/lancet/v2/cryptor" @@ -166,7 +184,7 @@ import "github.com/duke-git/lancet/v2/cryptor" - [RsaEncrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor_zh-CN.md#RsaEncrypt) - [RsaDecrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor_zh-CN.md#RsaDecrypt) -### 5. datetime日期时间处理包,格式化日期,比较日期。 +### 6. datetime日期时间处理包,格式化日期,比较日期。 ```go @@ -205,7 +223,7 @@ import "github.com/duke-git/lancet/v2/datetime" - [ToIso8601](https://github.com/duke-git/lancet/blob/main/docs/datetime_zh-CN.md#ToIso8601) -### 6. datastructure包含一些普通的数据结构实现。例如:list, linklist, stack, queue, set, tree, graph. +### 7. datastructure包含一些普通的数据结构实现。例如:list, linklist, stack, queue, set, tree, graph. ```go @@ -229,7 +247,7 @@ import hashmap "github.com/duke-git/lancet/v2/datastructure/hashmap" - [HashMap](https://github.com/duke-git/lancet/blob/main/docs/datastructure/hashmap.md) -### 7. fileutil包支持文件基本操作。 +### 8. fileutil包支持文件基本操作。 ```go import "github.com/duke-git/lancet/v2/fileutil" @@ -253,7 +271,7 @@ import "github.com/duke-git/lancet/v2/fileutil" - [Zip](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#Zip) - [UnZip](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#UnZip) -### 8. formatter格式化器包含一些数据格式化处理方法。 +### 9. formatter格式化器包含一些数据格式化处理方法。 ```go import "github.com/duke-git/lancet/v2/formatter" @@ -262,7 +280,7 @@ import "github.com/duke-git/lancet/v2/formatter" - [Comma](https://github.com/duke-git/lancet/blob/main/docs/formatter_zh-CN.md#Comma) -### 9. function函数包控制函数执行流程,包含部分函数式编程。 +### 10. function函数包控制函数执行流程,包含部分函数式编程。 ```go import "github.com/duke-git/lancet/v2/function" @@ -278,7 +296,7 @@ import "github.com/duke-git/lancet/v2/function" - [Watcher](https://github.com/duke-git/lancet/blob/main/docs/function_zh-CN.md#Watcher) -### 10. maputil包包括一些操作map的函数. +### 11. maputil包包括一些操作map的函数. ```go import "github.com/duke-git/lancet/v2/maputil" @@ -294,7 +312,7 @@ import "github.com/duke-git/lancet/v2/maputil" - [Values](https://github.com/duke-git/lancet/blob/main/docs/maputil_zh-CN.md#Values) - [IsDisjoint](https://github.com/duke-git/lancet/blob/main/docs/maputil_zh-CN.md#IsDisjoint) -### 11. mathutil包实现了一些数学计算的函数。 +### 12. mathutil包实现了一些数学计算的函数。 ```go import "github.com/duke-git/lancet/v2/mathutil" @@ -314,7 +332,7 @@ import "github.com/duke-git/lancet/v2/mathutil" - [RoundToString](https://github.com/duke-git/lancet/blob/main/docs/mathutil_zh-CN.md#RoundToString) - [TruncRound](https://github.com/duke-git/lancet/blob/main/docs/mathutil_zh-CN.md#TruncRound) -### 12. netutil网络包支持获取ip地址,发送http请求。 +### 13. netutil网络包支持获取ip地址,发送http请求。 ```go import "github.com/duke-git/lancet/v2/netutil" @@ -337,7 +355,7 @@ import "github.com/duke-git/lancet/v2/netutil" - [HttpPatch](https://github.com/duke-git/lancet/blob/main/docs/netutil_zh-CN.md#HttpPatch) - [ParseHttpResponse](https://github.com/duke-git/lancet/blob/main/docs/netutil_zh-CN.md#ParseHttpResponse) -### 13. random随机数生成器包,可以生成随机[]bytes, int, string。 +### 14. random随机数生成器包,可以生成随机[]bytes, int, string。 ```go import "github.com/duke-git/lancet/v2/random" @@ -348,7 +366,7 @@ import "github.com/duke-git/lancet/v2/random" - [RandInt](https://github.com/duke-git/lancet/blob/main/docs/random_zh-CN.md#RandInt) - [RandString](https://github.com/duke-git/lancet/blob/main/docs/random_zh-CN.md#RandString) - [UUIdV4](https://github.com/duke-git/lancet/blob/main/docs/random.md#UUIdV4) -### 14. retry重试执行函数直到函数运行成功或被context cancel。 +### 15. retry重试执行函数直到函数运行成功或被context cancel。 ```go import "github.com/duke-git/lancet/v2/retry" @@ -362,7 +380,7 @@ import "github.com/duke-git/lancet/v2/retry" - [RetryTimes](https://github.com/duke-git/lancet/blob/main/docs/retry_zh-CN.md#RetryTimes) -### 15. slice包包含操作切片的方法集合。 +### 16. slice包包含操作切片的方法集合。 ```go import "github.com/duke-git/lancet/v2/slice" @@ -413,7 +431,7 @@ import "github.com/duke-git/lancet/v2/slice" - [Without](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#Without) -### 16. strutil包含处理字符串的相关函数。 +### 17. strutil包含处理字符串的相关函数。 ```go import "github.com/duke-git/lancet/v2/strutil" @@ -440,7 +458,7 @@ import "github.com/duke-git/lancet/v2/strutil" - [Unwrap](https://github.com/duke-git/lancet/blob/main/docs/strutil_zh-CN.md#Unwrap) -### 17. system包含os, runtime, shell command相关函数。 +### 18. system包含os, runtime, shell command相关函数。 ```go import "github.com/duke-git/lancet/v2/system" @@ -457,7 +475,7 @@ import "github.com/duke-git/lancet/v2/system" - [ExecCommand](https://github.com/duke-git/lancet/blob/main/docs/system_zh-CN.md#ExecCommand) - [GetOsBits](https://github.com/duke-git/lancet/blob/main/docs/system_zh-CN.md#GetOsBits) -### 18. validator验证器包,包含常用字符串格式验证函数。 +### 19. validator验证器包,包含常用字符串格式验证函数。 ```go import "github.com/duke-git/lancet/v2/validator" @@ -492,7 +510,7 @@ import "github.com/duke-git/lancet/v2/validator" - [IsWeakPassword](https://github.com/duke-git/lancet/blob/main/docs/validator_zh-CN.md#IsWeakPassword) - [IsZeroValue](https://github.com/duke-git/lancet/blob/main/docs/validator_zh-CN.md#IsZeroValue) -### 19. xerror包实现一些错误处理函数 +### 20. xerror包实现一些错误处理函数 ```go import "github.com/duke-git/lancet/v2/xerror"