git/lancet
1
0
Fork 0
mirror of https://github.com/duke-git/lancet.git synced 2026-03-01 00:35:28 +08:00
Code Issues Projects Releases Wiki Activity

doc: update doc for fileutil package

Browse Source
This commit is contained in:
dudaodong
2023-01-03 14:33:29 +08:00
parent 3062eb7789
commit c8f8b1b7d9
3 changed files with 136 additions and 84 deletions
Download Patch File Download Diff File Expand all files Collapse all files

66
README.md
View File

@@ -179,7 +179,6 @@ import "github.com/duke-git/lancet/v2/condition"
[[doc](https://github.com/duke-git/lancet/blob/main/docs/condition.md#TernaryOperator)] [[doc](https://github.com/duke-git/lancet/blob/main/docs/condition.md#TernaryOperator)]
[[play](https://go.dev/play/p/ElllPZY0guT)] [[play](https://go.dev/play/p/ElllPZY0guT)]
### 4. Convertor package contains some functions for data convertion. ### 4. Convertor package contains some functions for data convertion.
```go ```go
@@ -187,6 +186,7 @@ import "github.com/duke-git/lancet/v2/convertor"
``` ```
#### Function list: #### Function list:
- **<big>ColorHexToRGB</big>** : convert color hex to color rgb. - **<big>ColorHexToRGB</big>** : convert color hex to color rgb.
[[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#ColorHexToRGB)] [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#ColorHexToRGB)]
[[play](https://go.dev/play/p/o7_ft-JCJBV)] [[play](https://go.dev/play/p/o7_ft-JCJBV)]
@@ -236,7 +236,6 @@ import "github.com/duke-git/lancet/v2/convertor"
[[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#DecodeByte)] [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#DecodeByte)]
[[play](https://go.dev/play/p/zI6xsmuQRbn)] [[play](https://go.dev/play/p/zI6xsmuQRbn)]
### 5. Cryptor package is for data encryption and decryption. ### 5. Cryptor package is for data encryption and decryption.
```go ```go
@@ -349,21 +348,51 @@ import "github.com/duke-git/lancet/v2/fileutil"
#### Function list： #### Function list：
- [ClearFile](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#ClearFile) - **<big>ClearFile</big>** : write empty string to target file.
- [CreateFile](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#CreateFile) [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#ClearFile)]
- [CreateDir](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#CreateDir) [[play](https://go.dev/play/p/NRZ0ZT-G94H)]
- [CopyFile](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#CopyFile) - **<big>CreateFile</big>** : create file in path.
- [FileMode](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#FileMode) [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#CreateFile)]
- [MiMeType](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#MiMeType) [[play](https://go.dev/play/p/lDt8PEsTNKI)]
- [IsExist](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#IsExist) - **<big>CreateDir</big>** : create directory in absolute path.
- [IsLink](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#IsLink) [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#CreateDir)]
- [IsDir](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#IsDir) [[play](https://go.dev/play/p/qUuCe1OGQnM)]
- [ListFileNames](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#ListFileNames) - **<big>CopyFile</big>** :copy src file to dest file.
- [RemoveFile](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#RemoveFile) [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#CopyFile)]
- [ReadFileToString](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#ReadFileToString) [[play](https://go.dev/play/p/Jg9AMJMLrJi)]
- [ReadFileByLine](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#ReadFileByLine) - **<big>FileMode</big>** : return file's mode and permission.
- [Zip](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#Zip) [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#FileMode)]
- [UnZip](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#UnZip) [[play](https://go.dev/play/p/2l2hI42fA3p)]
- **<big>MiMeType</big>** : return file mime type.
[[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#MiMeType)]
[[play](https://go.dev/play/p/bd5sevSUZNu)]
- **<big>IsExist</big>** : checks if a file or directory exists.
[[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#IsExist)]
[[play](https://go.dev/play/p/nKKXt8ZQbmh)]
- **<big>IsLink</big>** : checks if a file is symbol link or not.
[[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#IsLink)]
[[play](https://go.dev/play/p/TL-b-Kzvf44)]
- **<big>IsDir</big>** : checks if the path is directory or not.
[[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#IsDir)]
[[play](https://go.dev/play/p/WkVwEKqtOWk)]
- **<big>ListFileNames</big>** : return all file names in the path.
[[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#ListFileNames)]
[[play](https://go.dev/play/p/Tjd7Y07rejl)]
- **<big>RemoveFile</big>** : remove file, param should be file path.
[[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#RemoveFile)]
[[play](https://go.dev/play/p/P2y0XW8a1SH)]
- **<big>ReadFileToString</big>** : return string of file content.
[[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#ReadFileToString)]
[[play](https://go.dev/play/p/cmfwp_5SQTp)]
- **<big>ReadFileByLine</big>** : read file line by line, return string slice of file content.
[[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#ReadFileByLine)]
[[play](https://go.dev/play/p/svJP_7ZrBrD)]
- **<big>Zip</big>** : create zip file.
[[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#Zip)]
[[play](https://go.dev/play/p/j-3sWBp8ik_P)]
- **<big>UnZip</big>** : unzip the zip file and save it to dest path.
[[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#UnZip)]
[[play](https://go.dev/play/p/g0w34kS7B8m)]
### 9. Formatter contains some functions for data formatting. ### 9. Formatter contains some functions for data formatting.
@@ -377,7 +406,6 @@ import "github.com/duke-git/lancet/v2/formatter"
[[doc](https://github.com/duke-git/lancet/blob/main/docs/formatter.md#Comma)] [[doc](https://github.com/duke-git/lancet/blob/main/docs/formatter.md#Comma)]
[[play](https://go.dev/play/p/eRD5k2vzUVX)] [[play](https://go.dev/play/p/eRD5k2vzUVX)]
### 10. 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 ```go
@@ -428,7 +456,6 @@ import "github.com/duke-git/lancet/v2/maputil"
[[doc](https://github.com/duke-git/lancet/blob/main/docs/maputil.md#IsDisjoint)] [[doc](https://github.com/duke-git/lancet/blob/main/docs/maputil.md#IsDisjoint)]
[[play](https://go.dev/play/p/N9qgYg_Ho6f)] [[play](https://go.dev/play/p/N9qgYg_Ho6f)]
### 12. Mathutil package implements some functions for math calculation. ### 12. Mathutil package implements some functions for math calculation.
```go ```go
@@ -473,7 +500,6 @@ import "github.com/duke-git/lancet/v2/mathutil"
[[doc](https://github.com/duke-git/lancet/blob/main/docs/mathutil.md#TruncRound)] [[doc](https://github.com/duke-git/lancet/blob/main/docs/mathutil.md#TruncRound)]
[[play](https://go.dev/play/p/aumarSHIGzP)] [[play](https://go.dev/play/p/aumarSHIGzP)]
### 13. 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 ```go

68
README_zh-CN.md
View File

@@ -152,6 +152,7 @@ import "github.com/duke-git/lancet/v2/condition"
``` ```
#### Function list: #### Function list:
- **<big>Bool</big>** : 返回传入参数的 bool 值。 - **<big>Bool</big>** : 返回传入参数的 bool 值。
[[doc](https://github.com/duke-git/lancet/blob/main/docs/condition_zh-CN.md#Bool)] [[doc](https://github.com/duke-git/lancet/blob/main/docs/condition_zh-CN.md#Bool)]
[[play](https://go.dev/play/p/ETzeDJRSvhm)] [[play](https://go.dev/play/p/ETzeDJRSvhm)]
@@ -177,7 +178,6 @@ import "github.com/duke-git/lancet/v2/condition"
[[doc](https://github.com/duke-git/lancet/blob/main/docs/condition_zh-CN.md#TernaryOperator)] [[doc](https://github.com/duke-git/lancet/blob/main/docs/condition_zh-CN.md#TernaryOperator)]
[[play](https://go.dev/play/p/ElllPZY0guT)] [[play](https://go.dev/play/p/ElllPZY0guT)]
### 4. convertor 转换器包支持一些常见的数据类型转换。 ### 4. convertor 转换器包支持一些常见的数据类型转换。
```go ```go
@@ -185,6 +185,7 @@ import "github.com/duke-git/lancet/v2/convertor"
``` ```
#### 函数列表: #### 函数列表:
- **<big>ColorHexToRGB</big>** : 颜色值十六进制转 rgb。 - **<big>ColorHexToRGB</big>** : 颜色值十六进制转 rgb。
[[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#ColorHexToRGB)] [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#ColorHexToRGB)]
[[play](https://go.dev/play/p/o7_ft-JCJBV)] [[play](https://go.dev/play/p/o7_ft-JCJBV)]
@@ -234,7 +235,6 @@ import "github.com/duke-git/lancet/v2/convertor"
[[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#DecodeByte)] [[doc](https://github.com/duke-git/lancet/blob/main/docs/convertor_zh-CN.md#DecodeByte)]
[[play](https://go.dev/play/p/zI6xsmuQRbn)] [[play](https://go.dev/play/p/zI6xsmuQRbn)]
### 5. cryptor 加密包支持数据加密和解密，获取 md5，hash 值。支持 base64, md5, hmac, aes, des, rsa。 ### 5. cryptor 加密包支持数据加密和解密，获取 md5，hash 值。支持 base64, md5, hmac, aes, des, rsa。
```go ```go
@@ -347,21 +347,51 @@ import "github.com/duke-git/lancet/v2/fileutil"
#### 函数列表： #### 函数列表：
- [ClearFile](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#ClearFile) - **<big>ClearFile</big>** : 清空文件内容。
- [CreateFile](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#CreateFile) [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#ClearFile)]
- [CreateDir](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#CreateDir) [[play](https://go.dev/play/p/NRZ0ZT-G94H)]
- [CopyFile](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#CopyFile) - **<big>CreateFile</big>** : 创建文件，创建成功返回 true, 否则返回 false。
- [FileMode](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#FileMode) [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#CreateFile)]
- [MiMeType](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#MiMeType) [[play](https://go.dev/play/p/lDt8PEsTNKI)]
- [IsExist](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#IsExist) - **<big>CreateDir</big>** : 创建嵌套目录，例如/a/, /a/b/。
- [IsLink](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#IsLink) [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#CreateDir)]
- [IsDir](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#IsDir) [[play](https://go.dev/play/p/qUuCe1OGQnM)]
- [ListFileNames](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#ListFileNames) - **<big>CopyFile</big>** :拷贝文件，会覆盖原有的文件。
- [RemoveFile](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#RemoveFile) [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#CopyFile)]
- [ReadFileToString](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#ReadFileToString) [[play](https://go.dev/play/p/Jg9AMJMLrJi)]
- [ReadFileByLine](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#ReadFileByLine) - **<big>FileMode</big>** : 获取文件 mode 信息。
- [Zip](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#Zip) [[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#FileMode)]
- [UnZip](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#UnZip) [[play](https://go.dev/play/p/2l2hI42fA3p)]
- **<big>MiMeType</big>** : 获取文件 mime 类型, 参数的类型必须是 string 或者\*os.File。
[[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#MiMeType)]
[[play](https://go.dev/play/p/bd5sevSUZNu)]
- **<big>IsExist</big>** : 判断文件或目录是否存在。
[[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#IsExist)]
[[play](https://go.dev/play/p/nKKXt8ZQbmh)]
- **<big>IsLink</big>** : 判断文件是否是符号链接。
[[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#IsLink)]
[[play](https://go.dev/play/p/TL-b-Kzvf44)]
- **<big>IsDir</big>** : 判断参数是否是目录。
[[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#IsDir)]
[[play](https://go.dev/play/p/WkVwEKqtOWk)]
- **<big>ListFileNames</big>** : 返回目录下所有文件名。
[[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#ListFileNames)]
[[play](https://go.dev/play/p/Tjd7Y07rejl)]
- **<big>RemoveFile</big>** : 删除文件。
[[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#RemoveFile)]
[[play](https://go.dev/play/p/P2y0XW8a1SH)]
- **<big>ReadFileToString</big>** : 读取文件内容并返回字符串。
[[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#ReadFileToString)]
[[play](https://go.dev/play/p/cmfwp_5SQTp)]
- **<big>ReadFileByLine</big>** : 按行读取文件内容，返回字符串切片包含每一行。
[[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#ReadFileByLine)]
[[play](https://go.dev/play/p/svJP_7ZrBrD)]
- **<big>Zip</big>** : zip 压缩文件, 参数可以是文件或目录。
[[doc](https://github.com/duke-git/lancet/blob/main/docs/fileutil_zh-CN.md#Zip)]
[[play](https://go.dev/play/p/j-3sWBp8ik_P)]
- **<big>UnZip</big>** : zip 解压缩文件并保存在目录中。
[[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 格式化器包含一些数据格式化处理方法。
@@ -375,8 +405,6 @@ import "github.com/duke-git/lancet/v2/formatter"
[[doc](https://github.com/duke-git/lancet/blob/main/docs/formatter_zh-CN.md#Comma)] [[doc](https://github.com/duke-git/lancet/blob/main/docs/formatter_zh-CN.md#Comma)]
[[play](https://go.dev/play/p/eRD5k2vzUVX)] [[play](https://go.dev/play/p/eRD5k2vzUVX)]
### 10. function 函数包控制函数执行流程，包含部分函数式编程。 ### 10. function 函数包控制函数执行流程，包含部分函数式编程。
```go ```go
@@ -427,7 +455,6 @@ import "github.com/duke-git/lancet/v2/maputil"
[[doc](https://github.com/duke-git/lancet/blob/main/docs/maputil_zh-CN.md#IsDisjoint)] [[doc](https://github.com/duke-git/lancet/blob/main/docs/maputil_zh-CN.md#IsDisjoint)]
[[play](https://go.dev/play/p/N9qgYg_Ho6f)] [[play](https://go.dev/play/p/N9qgYg_Ho6f)]
### 12. mathutil 包实现了一些数学计算的函数。 ### 12. mathutil 包实现了一些数学计算的函数。
```go ```go
@@ -472,7 +499,6 @@ import "github.com/duke-git/lancet/v2/mathutil"
[[doc](https://github.com/duke-git/lancet/blob/main/docs/mathutil_zh-CN.md#TruncRound)] [[doc](https://github.com/duke-git/lancet/blob/main/docs/mathutil_zh-CN.md#TruncRound)]
[[play](https://go.dev/play/p/aumarSHIGzP)] [[play](https://go.dev/play/p/aumarSHIGzP)]
### 13. netutil 网络包支持获取 ip 地址，发送 http 请求。 ### 13. netutil 网络包支持获取 ip 地址，发送 http 请求。
```go ```go

4
docs/fileutil_zh-CN.md
View File

@@ -119,7 +119,7 @@ func main() {
### <span id="CopyFile">CopyFile</span> ### <span id="CopyFile">CopyFile</span>
<p>拷贝文件，会覆盖原有的拷贝文件</p> <p>拷贝文件，会覆盖原有的文件</p>
<b>函数签名:</b> <b>函数签名:</b>
@@ -261,7 +261,7 @@ func main() {
### <span id="IsDir">IsDir</span> ### <span id="IsDir">IsDir</span>
<p>判断目录是否存在</p> <p>判断参数是否是目录</p>
<b>函数签名:</b> <b>函数签名:</b>