doc: add play ground demo

release v2.1.18
doc: update readme file for new feature
2026-02-13 17:22:27 +08:00 · 2023-04-03 10:33:57 +08:00 · 2023-04-03 10:12:50 +08:00 · 2023-04-03 10:12:13 +08:00 · 2023-03-31 12:00:32 +08:00 · 2023-03-30 14:52:32 +08:00
17 changed files with 551 additions and 37 deletions
--- a/README.md
+++ b/README.md
@@ -4,7 +4,7 @@
 <br/>

 ![Go version](https://img.shields.io/badge/go-%3E%3Dv1.18-9cf)
-[![Release](https://img.shields.io/badge/release-2.1.17-green.svg)](https://github.com/duke-git/lancet/releases)
+[![Release](https://img.shields.io/badge/release-2.1.18-green.svg)](https://github.com/duke-git/lancet/releases)
 [![GoDoc](https://godoc.org/github.com/duke-git/lancet/v2?status.svg)](https://pkg.go.dev/github.com/duke-git/lancet/v2)
 [![Go Report Card](https://goreportcard.com/badge/github.com/duke-git/lancet/v2)](https://goreportcard.com/report/github.com/duke-git/lancet/v2)
 [![test](https://github.com/duke-git/lancet/actions/workflows/codecov.yml/badge.svg?branch=main&event=push)](https://github.com/duke-git/lancet/actions/workflows/codecov.yml)
@@ -709,7 +709,18 @@ import "github.com/duke-git/lancet/v2/mathutil"
 -   **<big>RangeWithStep</big>** : 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)]
    [[play](https://go.dev/play/p/akLWz0EqOSM)]
-
+-   **<big>AngleToRadian</big>** : converts angle value to radian value.
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/mathutil.md#AngleToRadian)]
+    [[play](https://go.dev/play/p/CIvlICqrHql)]
+-   **<big>RadianToAngle</big>** : converts radian value to angle value.
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/mathutil.md#RadianToAngle)]
+    [[play](https://go.dev/play/p/dQtmOTUOMgi)]
+-   **<big>PointDistance</big>** : get two points distance.
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/mathutil.md#PointDistance)]
+    [[play](https://go.dev/play/p/RrG4JIaziM8)]
+-   **<big>IsPrime</big>** : checks if number is prime number.
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/mathutil.md#IsPrime)]
+    [[play](https://go.dev/play/p/Rdd8UTHZJ7u)]

 ### 13. Netutil package contains functions to get net information and send http request.

@@ -1032,7 +1043,6 @@ 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. Structs package provides several high level functions to manipulate struct, tag, and field.

 ```go
@@ -1142,6 +1152,10 @@ import "github.com/duke-git/lancet/v2/strutil"
 -   **<big>WordCount</big>** : return the number of meaningful word of a string, word only contains alphabetic characters.
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/strutil.md#WordCount)]
    [[play](https://go.dev/play/p/bj7_odx3vRf)]
+-   **<big>RemoveNonPrintable</big>** : remove non-printable characters from a string.
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/strutil.md#RemoveNonPrintable)]
+    [[play](https://go.dev/play/p/og47F5x_jTZ)]
+

 ### 19. System package contain some functions about os, runtime, shell command.

@@ -1271,6 +1285,12 @@ import "github.com/duke-git/lancet/v2/validator"
 -   **<big>IsGBK</big>** : check if data encoding is gbk.
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsGBK)]
    [[play](https://go.dev/play/p/E2nt3unlmzP)]
+-   **<big>IsASCII</big>** : checks if string is all ASCII char.
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsASCII)]
+    [[play](https://go.dev/play/p/hfQNPLX0jNa)]
+-   **<big>IsPrintable</big>** : checks if string is all printable chars.
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsPrintable)]
+    [[play](https://go.dev/play/p/Pe1FE2gdtTP)]

 ### 21. xerror package implements helpers for errors.

--- a/README_zh-CN.md
+++ b/README_zh-CN.md
@@ -4,7 +4,7 @@
 <br/>

 ![Go version](https://img.shields.io/badge/go-%3E%3Dv1.18-9cf)
-[![Release](https://img.shields.io/badge/release-2.1.17-green.svg)](https://github.com/duke-git/lancet/releases)
+[![Release](https://img.shields.io/badge/release-2.1.18-green.svg)](https://github.com/duke-git/lancet/releases)
 [![GoDoc](https://godoc.org/github.com/duke-git/lancet/v2?status.svg)](https://pkg.go.dev/github.com/duke-git/lancet/v2)
 [![Go Report Card](https://goreportcard.com/badge/github.com/duke-git/lancet/v2)](https://goreportcard.com/report/github.com/duke-git/lancet/v2)
 [![test](https://github.com/duke-git/lancet/actions/workflows/codecov.yml/badge.svg?branch=main&event=push)](https://github.com/duke-git/lancet/actions/workflows/codecov.yml)
@@ -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"
 -   **<big>Hashmap</big>** : 哈希映射。
    [[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"
@@ -708,9 +708,20 @@ import "github.com/duke-git/lancet/v2/mathutil"
 -   **<big>RangeWithStep</big>** : 根据指定的起始值，结束值，步长，创建一个数字切片。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/mathutil_zh-CN.md#RangeWithStep)]
    [[play](https://go.dev/play/p/akLWz0EqOSM)]
+-   **<big>AngleToRadian</big>** : 将角度值转为弧度值。
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/mathutil_zh-CN.md#AngleToRadian)]
+    [[play](https://go.dev/play/p/CIvlICqrHql)]
+-   **<big>RadianToAngle</big>** : 将弧度值转为角度值。
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/mathutil_zh-CN.md#RadianToAngle)]
+    [[play](https://go.dev/play/p/dQtmOTUOMgi)]
+-   **<big>PointDistance</big>** : 计算两个坐标点的距离。
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/mathutil_zh-CN.md#PointDistance)]
+    [[play](https://go.dev/play/p/RrG4JIaziM8)]
+-   **<big>IsPrime</big>** : 判断质数。
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/mathutil_zh-CN.md#IsPrime)]
+    [[play](https://go.dev/play/p/Rdd8UTHZJ7u)]

-
-### 13. netutil网络包支持获取 ip 地址，发送 http 请求。
+### 13. netutil 网络包支持获取 ip 地址，发送 http 请求。

 ```go
 import "github.com/duke-git/lancet/v2/netutil"
@@ -773,7 +784,7 @@ import "github.com/duke-git/lancet/v2/netutil"
 -   **<big>ParseHttpResponse</big>** : 解析 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"
@@ -806,7 +817,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"
@@ -830,7 +841,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"
@@ -922,7 +933,7 @@ import "github.com/duke-git/lancet/v2/slice"
 -   **<big>ForEach</big>** : 遍历切片的元素并为每个元素调用 iteratee 函数。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#ForEach)]
    [[play](https://go.dev/play/p/DrPaa4YsHRF)]
-   **<big>ForEachWithBreak</big>** : 遍历切片的元素并为每个元素调用iteratee函数，当iteratee函数返回false时，终止遍历。
+-   **<big>ForEachWithBreak</big>** : 遍历切片的元素并为每个元素调用 iteratee 函数，当 iteratee 函数返回 false 时，终止遍历。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/slice_zh-CN.md#ForEachWithBreak)]
    [[play](https://go.dev/play/p/qScs39f3D9W)]
 -   **<big>GroupBy</big>** : 迭代切片的元素，每个元素将按条件分组，返回两个切片。
@@ -1031,7 +1042,7 @@ 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. structs提供操作struct, tag, field的相关函数。
+### 17. structs 提供操作 struct, tag, field 的相关函数。

 ```go
 import "github.com/duke-git/lancet/v2/structs"
@@ -1041,21 +1052,21 @@ import "github.com/duke-git/lancet/v2/structs"

 -   **<big>New</big>** : `Struct`结构体的构造函数。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/structs/struct_zh-CN.md#New)]
-   **<big>ToMap</big>** : 将一个合法的struct对象转换为map[string]any。
+-   **<big>ToMap</big>** : 将一个合法的 struct 对象转换为 map[string]any。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/structs/struct_zh-CN.md#ToMap)]
-   **<big>Fields</big>** : 获取一个struct对象的属性列表。
+-   **<big>Fields</big>** : 获取一个 struct 对象的属性列表。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/structs/struct_zh-CN.md#Fields)]
-   **<big>Field</big>** : 根据属性名获取一个struct对象的属性。
+-   **<big>Field</big>** : 根据属性名获取一个 struct 对象的属性。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/structs/struct_zh-CN.md#Fields)]
-   **<big>IsStruct</big>** : 判断是否为一个合法的struct对象。
+-   **<big>IsStruct</big>** : 判断是否为一个合法的 struct 对象。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/structs/struct_zh-CN.md#IsStruct)]
-   **<big>Tag</big>** : 获取`Field`的`Tag`，默认的tag key是json。
+-   **<big>Tag</big>** : 获取`Field`的`Tag`，默认的 tag key 是 json。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/structs/field_zh-CN.md#Tag)]
 -   **<big>Name</big>** : 获取属性名。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/structs/field_zh-CN.md#Name)]
 -   **<big>Value</big>** : 获取`Field`属性的值。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/structs/field_zh-CN.md#Value)]
-   **<big>Kind</big>** : 获取属性Kind。
+-   **<big>Kind</big>** : 获取属性 Kind。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/structs/field_zh-CN.md#Kind)]
 -   **<big>IsEmbedded</big>** : 判断属性是否为嵌入。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/structs/field_zh-CN.md#IsEmbedded)]
@@ -1066,7 +1077,7 @@ import "github.com/duke-git/lancet/v2/structs"
 -   **<big>IsSlice</big>** : 判断属性是否是切片。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/structs/field_zh-CN.md#IsSlice)]

-### 18. strutil包含字符串处理的相关函数。
+### 18. strutil 包含字符串处理的相关函数。

 ```go
 import "github.com/duke-git/lancet/v2/strutil"
@@ -1143,9 +1154,11 @@ import "github.com/duke-git/lancet/v2/strutil"
 -   **<big>WordCount</big>** : 返回有意义单词的数量，只支持字母字符单词。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/strutil_zh-CN.md#WordCount)]
    [[play](https://go.dev/play/p/bj7_odx3vRf)]
+-   **<big>RemoveNonPrintable</big>** : 删除字符串中不可打印的字符。
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/strutil_zh-CN.md#RemoveNonPrintable)]
+    [[play](https://go.dev/play/p/og47F5x_jTZ)]

-
-### 19. system包含 os, runtime, shell command 的相关函数。
+### 19. system 包含 os, runtime, shell command 的相关函数。

 ```go
 import "github.com/duke-git/lancet/v2/system"
@@ -1181,7 +1194,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)]

-### 20. validator验证器包，包含常用字符串格式验证函数。
+### 20. validator 验证器包，包含常用字符串格式验证函数。

 ```go
 import "github.com/duke-git/lancet/v2/validator"
@@ -1273,8 +1286,14 @@ import "github.com/duke-git/lancet/v2/validator"
 -   **<big>IsGBK</big>** : 检查数据编码是否为 gbk（汉字内部代码扩展规范）。
    [[doc](https://github.com/duke-git/lancet/blob/main/docs/validator_zh-CN.md#IsGBK)]
    [[play](https://go.dev/play/p/E2nt3unlmzP)]
+-   **<big>IsASCII</big>** : 验证字符串全部为 ASCII 字符。
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/validator_zh-CN.md#IsASCII)]
+    [[play](https://go.dev/play/p/hfQNPLX0jNa)]
+-   **<big>IsPrintable</big>** : 检查字符串是否全部为可打印字符。
+    [[doc](https://github.com/duke-git/lancet/blob/main/docs/validator_zh-CN.md#IsPrintable)]
+    [[play](https://go.dev/play/p/Pe1FE2gdtTP)]

-### 21. xerror包实现一些错误处理函数
+### 21. xerror 包实现一些错误处理函数

 ```go
 import "github.com/duke-git/lancet/v2/xerror"
--- a/docs/mathutil.md
+++ b/docs/mathutil.md
@@ -39,6 +39,7 @@ import (
 -   [AngleToRadian](#AngleToRadian)
 -   [RadianToAngle](#RadianToAngle)
 -   [PointDistance](#PointDistance)
+-   [IsPrime](#IsPrime)

 <div STYLE="page-break-after: always;"></div>

@@ -661,4 +662,44 @@ func main() {
    // Output:
    // 5
 }
+```
+
+
+### <span id="IsPrime">IsPrime</span>
+
+<p>Checks if number is prime number.</p>
+
+<b>Signature:</b>
+
+```go
+func IsPrime(n int) bool
+```
+
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/mathutil"
+)
+
+func main() {
+    result1 := mathutil.IsPrime(-1)
+	result2 := mathutil.IsPrime(0)
+	result3 := mathutil.IsPrime(1)
+	result4 := mathutil.IsPrime(2)
+
+	fmt.Println(result1)
+	fmt.Println(result2)
+	fmt.Println(result3)
+	fmt.Println(result4)
+
+	// Output:
+	// false
+	// false
+	// false
+	// true
+}
 ```
--- a/docs/mathutil_zh-CN.md
+++ b/docs/mathutil_zh-CN.md
@@ -39,6 +39,7 @@ import (
 -   [AngleToRadian](#AngleToRadian)
 -   [RadianToAngle](#RadianToAngle)
 -   [PointDistance](#PointDistance)
+-   [IsPrime](#IsPrime)

 <div STYLE="page-break-after: always;"></div>

@@ -661,3 +662,43 @@ func main() {
    // 5
 }
 ```
+
+
+
+### <span id="IsPrime">IsPrime</span>
+
+<p>判断质数。</p>
+
+<b>函数签名:</b>
+
+```go
+func IsPrime(n int) bool
+```
+
+<b>示例:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/mathutil"
+)
+
+func main() {
+    result1 := mathutil.IsPrime(-1)
+	result2 := mathutil.IsPrime(0)
+	result3 := mathutil.IsPrime(1)
+	result4 := mathutil.IsPrime(2)
+
+	fmt.Println(result1)
+	fmt.Println(result2)
+	fmt.Println(result3)
+	fmt.Println(result4)
+
+	// Output:
+	// false
+	// false
+	// false
+	// true
+}
--- a/docs/strutil.md
+++ b/docs/strutil.md
@@ -45,6 +45,7 @@ import (
 -   [Unwrap](#Unwrap)
 -   [SplitWords](#SplitWords)
 -   [WordCount](#WordCount)
+-   [RemoveNonPrintable](#RemoveNonPrintable)

 <div STYLE="page-break-after: always;"></div>

@@ -937,4 +938,35 @@ func main() {
    // 0
    // 0
 }
+```
+
+
+### <span id="RemoveNonPrintable">RemoveNonPrintable</span>
+
+<p>Remove non-printable characters from a string.</p>
+
+<b>Signature:</b>
+
+```go
+func RemoveNonPrintable(str string) string
+```
+
+<b>Example:</b>
+
+```go
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/strutil"
+)
+
+func main() {
+    result1 := strutil.RemoveNonPrintable("hello\u00a0 \u200bworld\n")
+    result2 := strutil.RemoveNonPrintable("你好😄")
+
+    fmt.Println(result1)
+    fmt.Println(result2)
+    // Output:
+    // hello world
+    // 你好😄
+}
 ```
--- a/docs/strutil_zh-CN.md
+++ b/docs/strutil_zh-CN.md
@@ -45,6 +45,7 @@ import (
 -   [Unwrap](#Unwrap)
 -   [SplitWords](#SplitWords)
 -   [WordCount](#WordCount)
+-   [RemoveNonPrintable](#RemoveNonPrintable)

 <div STYLE="page-break-after: always;"></div>

@@ -936,4 +937,35 @@ func main() {
    // 0
    // 0
 }
+```
+
+
+### <span id="RemoveNonPrintable">RemoveNonPrintable</span>
+
+<p>删除字符串中不可打印的字符。</p>
+
+<b>函数签名:</b>
+
+```go
+func RemoveNonPrintable(str string) string
+```
+
+<b>示例:</b>
+
+```go
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/strutil"
+)
+
+func main() {
+    result1 := strutil.RemoveNonPrintable("hello\u00a0 \u200bworld\n")
+    result2 := strutil.RemoveNonPrintable("你好😄")
+
+    fmt.Println(result1)
+    fmt.Println(result2)
+    // Output:
+    // hello world
+    // 你好😄
+}
 ```
--- a/docs/validator.md
+++ b/docs/validator.md
@@ -29,6 +29,7 @@ import (
 -   [IsAlpha](#IsAlpha)
 -   [IsAllUpper](#IsAllUpper)
 -   [IsAllLower](#IsAllLower)
+-   [IsASCII](#IsASCII)
 -   [IsBase64](#IsBase64)
 -   [IsChineseMobile](#IsChineseMobile)
 -   [IsChineseIdNum](#IsChineseIdNum)
@@ -50,6 +51,7 @@ import (
 -   [IsWeakPassword](#IsWeakPassword)
 -   [IsZeroValue](#IsZeroValue)
 -   [IsGBK](#IsGBK)
+-   [IsPrintable](#IsPrintable)

 <div STYLE="page-break-after: always;"></div>

@@ -293,6 +295,46 @@ func main() {
 }
 ```

+### <span id="IsASCII">IsASCII</span>
+
+<p>Checks if string is all ASCII char.</p>
+
+<b>Signature:</b>
+
+```go
+func IsASCII(str string) bool
+```
+
+<b>Example:</b>
+
+```go
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/validator"
+)
+
+func main() {
+    result1 := validator.IsASCII("ABC")
+    result2 := validator.IsASCII("123")
+    result3 := validator.IsASCII("")
+    result4 := validator.IsASCII("😄")
+    result5 := validator.IsASCII("你好")
+
+    fmt.Println(result1)
+    fmt.Println(result2)
+    fmt.Println(result3)
+    fmt.Println(result4)
+    fmt.Println(result5)
+
+    // Output:
+    // true
+    // true
+    // true
+    // false
+    // false
+}
+```
+
 ### <span id="IsBase64">IsBase64</span>

 <p>Check if the string is base64 string.</p>
@@ -990,3 +1032,44 @@ func main() {
    // true
 }
 ```
+
+
+### <span id="IsPrintable">IsPrintable</span>
+
+<p>Checks if string is all printable chars.</p>
+
+<b>Signature:</b>
+
+```go
+func IsPrintable(str string) bool
+```
+
+<b>Example:</b>
+
+```go
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/validator"
+)
+
+func main() {
+    result1 := validator.IsPrintable("ABC")
+    result2 := validator.IsPrintable("{id: 123}")
+    result3 := validator.IsPrintable("")
+    result4 := validator.IsPrintable("😄")
+    result5 := validator.IsPrintable("\u0000")
+
+    fmt.Println(result1)
+    fmt.Println(result2)
+    fmt.Println(result3)
+    fmt.Println(result4)
+    fmt.Println(result5)
+
+    // Output:
+    // true
+    // true
+    // true
+    // true
+    // false
+}
+```
--- a/docs/validator_zh-CN.md
+++ b/docs/validator_zh-CN.md
@@ -29,6 +29,7 @@ import (
 -   [IsAlpha](#IsAlpha)
 -   [IsAllUpper](#IsAllUpper)
 -   [IsAllLower](#IsAllLower)
+-   [IsASCII](#IsASCII)
 -   [IsBase64](#IsBase64)
 -   [IsChineseMobile](#IsChineseMobile)
 -   [IsChineseIdNum](#IsChineseIdNum)
@@ -50,6 +51,7 @@ import (
 -   [IsWeakPassword](#IsWeakPassword)
 -   [IsZeroValue](#IsZeroValue)
 -   [IsGBK](#IsGBK)
+-   [IsPrintable](#IsPrintable)

 <div STYLE="page-break-after: always;"></div>

@@ -293,6 +295,46 @@ func main() {
 }
 ```

+### <span id="IsASCII">IsASCII</span>
+
+<p>验证字符串全部为ASCII字符。</p>
+
+<b>函数签名:</b>
+
+```go
+func IsASCII(str string) bool
+```
+
+<b>示例:</b>
+
+```go
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/validator"
+)
+
+func main() {
+    result1 := validator.IsASCII("ABC")
+    result2 := validator.IsASCII("123")
+    result3 := validator.IsASCII("")
+    result4 := validator.IsASCII("😄")
+    result5 := validator.IsASCII("你好")
+
+    fmt.Println(result1)
+    fmt.Println(result2)
+    fmt.Println(result3)
+    fmt.Println(result4)
+    fmt.Println(result5)
+
+    // Output:
+    // true
+    // true
+    // true
+    // false
+    // false
+}
+```
+
 ### <span id="IsBase64">IsBase64</span>

 <p>验证字符串是否是base64编码</p>
@@ -990,3 +1032,44 @@ func main() {
    // true
 }
 ```
+
+
+### <span id="IsPrintable">IsPrintable</span>
+
+<p>检查字符串是否全部为可打印字符。</p>
+
+<b>函数签名:</b>
+
+```go
+func IsPrintable(str string) bool
+```
+
+<b>示例:</b>
+
+```go
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/validator"
+)
+
+func main() {
+    result1 := validator.IsPrintable("ABC")
+    result2 := validator.IsPrintable("{id: 123}")
+    result3 := validator.IsPrintable("")
+    result4 := validator.IsPrintable("😄")
+    result5 := validator.IsPrintable("\u0000")
+
+    fmt.Println(result1)
+    fmt.Println(result2)
+    fmt.Println(result3)
+    fmt.Println(result4)
+    fmt.Println(result5)
+
+    // Output:
+    // true
+    // true
+    // true
+    // true
+    // false
+}
+```
--- a/mathutil/mathutil.go
+++ b/mathutil/mathutil.go
@@ -218,21 +218,21 @@ func RangeWithStep[T constraints.Integer | constraints.Float](start, end, step T
 }

 // AngleToRadian converts angle value to radian value.
-// Play: todo
+// Play: https://go.dev/play/p/CIvlICqrHql
 func AngleToRadian(angle float64) float64 {
 	radian := angle * (math.Pi / 180)
 	return radian
 }

 // RadianToAngle converts radian value to angle value.
-// Play: todo
+// Play: https://go.dev/play/p/dQtmOTUOMgi
 func RadianToAngle(radian float64) float64 {
 	angle := radian * (180 / math.Pi)
 	return angle
 }

 // PointDistance get two points distance.
-// Play: todo
+// Play: https://go.dev/play/p/RrG4JIaziM8
 func PointDistance(x1, y1, x2, y2 float64) float64 {
 	a := x1 - x2
 	b := y1 - y2
@@ -240,3 +240,19 @@ func PointDistance(x1, y1, x2, y2 float64) float64 {

 	return math.Sqrt(c)
 }
+
+// IsPrimes checks if number is prime number.
+// Play: https://go.dev/play/p/Rdd8UTHZJ7u
+func IsPrime(n int) bool {
+	if n < 2 {
+		return false
+	}
+
+	for i := 2; i <= int(math.Sqrt(float64(n))); i++ {
+		if n%i == 0 {
+			return false
+		}
+	}
+
+	return true
+}
--- a/mathutil/mathutil_exmaple_test.go
+++ b/mathutil/mathutil_exmaple_test.go
@@ -263,3 +263,21 @@ func ExamplePointDistance() {
 	// Output:
 	// 5
 }
+
+func ExampleIsPrime() {
+	result1 := IsPrime(-1)
+	result2 := IsPrime(0)
+	result3 := IsPrime(1)
+	result4 := IsPrime(2)
+
+	fmt.Println(result1)
+	fmt.Println(result2)
+	fmt.Println(result3)
+	fmt.Println(result4)
+
+	// Output:
+	// false
+	// false
+	// false
+	// true
+}
--- a/mathutil/mathutil_test.go
+++ b/mathutil/mathutil_test.go
@@ -200,3 +200,14 @@ func TestPointDistance(t *testing.T) {

 	assert.Equal(float64(5), result1)
 }
+
+func TestIsPrime(t *testing.T) {
+	assert := internal.NewAssert(t, "TestIsPrime")
+
+	assert.Equal(false, IsPrime(-1))
+	assert.Equal(false, IsPrime(0))
+	assert.Equal(false, IsPrime(1))
+	assert.Equal(true, IsPrime(2))
+	assert.Equal(true, IsPrime(3))
+	assert.Equal(false, IsPrime(4))
+}
--- a/strutil/string.go
+++ b/strutil/string.go
@@ -360,3 +360,16 @@ func WordCount(s string) int {

 	return count
 }
+
+// RemoveNonPrintable remove non-printable characters from a string.
+// Play: https://go.dev/play/p/og47F5x_jTZ
+func RemoveNonPrintable(str string) string {
+	result := strings.Map(func(r rune) rune {
+		if unicode.IsPrint(r) {
+			return r
+		}
+		return -1
+	}, str)
+
+	return result
+}
--- a/strutil/string_example_test.go
+++ b/strutil/string_example_test.go
@@ -438,3 +438,14 @@ func ExampleWordCount() {
 	// 0
 	// 0
 }
+
+func ExampleRemoveNonPrintable() {
+	result1 := RemoveNonPrintable("hello\u00a0 \u200bworld\n")
+	result2 := RemoveNonPrintable("你好😄")
+
+	fmt.Println(result1)
+	fmt.Println(result2)
+	// Output:
+	// hello world
+	// 你好😄
+}
--- a/strutil/string_test.go
+++ b/strutil/string_test.go
@@ -342,3 +342,10 @@ func TestWordCount(t *testing.T) {
 		assert.Equal(v, WordCount(k))
 	}
 }
+
+func TestRemoveNonPrintable(t *testing.T) {
+	assert := internal.NewAssert(t, "TestRemoveNonPrintable")
+
+	assert.Equal("hello world", RemoveNonPrintable("hello\u00a0 \u200bworld\n"))
+	assert.Equal("你好😄", RemoveNonPrintable("你好😄"))
+}
--- a/validator/validator.go
+++ b/validator/validator.go
@@ -58,6 +58,31 @@ func IsAllLower(str string) bool {
 	return str != ""
 }

+// IsASCII checks if string is all ASCII char.
+// Play: https://go.dev/play/p/hfQNPLX0jNa
+func IsASCII(str string) bool {
+	for i := 0; i < len(str); i++ {
+		if str[i] > unicode.MaxASCII {
+			return false
+		}
+	}
+	return true
+}
+
+// IsPrintable checks if string is all printable chars.
+// Play: https://go.dev/play/p/Pe1FE2gdtTP
+func IsPrintable(str string) bool {
+	for _, r := range str {
+		if !unicode.IsPrint(r) {
+			if r == '\n' || r == '\r' || r == '\t' || r == '`' {
+				continue
+			}
+			return false
+		}
+	}
+	return true
+}
+
 // ContainUpper check if the string contain at least one upper case letter A-Z.
 // Play: https://go.dev/play/p/CmWeBEk27-z
 func ContainUpper(str string) bool {
--- a/validator/validator_example_test.go
+++ b/validator/validator_example_test.go
@@ -407,3 +407,45 @@ func ExampleIsGBK() {
 	// Output:
 	// true
 }
+
+func ExampleIsASCII() {
+	result1 := IsASCII("ABC")
+	result2 := IsASCII("123")
+	result3 := IsASCII("")
+	result4 := IsASCII("😄")
+	result5 := IsASCII("你好")
+
+	fmt.Println(result1)
+	fmt.Println(result2)
+	fmt.Println(result3)
+	fmt.Println(result4)
+	fmt.Println(result5)
+
+	// Output:
+	// true
+	// true
+	// true
+	// false
+	// false
+}
+
+func ExampleIsPrintable() {
+	result1 := IsPrintable("ABC")
+	result2 := IsPrintable("{id: 123}")
+	result3 := IsPrintable("")
+	result4 := IsPrintable("😄")
+	result5 := IsPrintable("\u0000")
+
+	fmt.Println(result1)
+	fmt.Println(result2)
+	fmt.Println(result3)
+	fmt.Println(result4)
+	fmt.Println(result5)
+
+	// Output:
+	// true
+	// true
+	// true
+	// true
+	// false
+}
--- a/validator/validator_test.go
+++ b/validator/validator_test.go
@@ -401,3 +401,23 @@ func TestIsGBK(t *testing.T) {
 	assert.Equal(true, IsGBK(gbkData))
 	assert.Equal(false, utf8.Valid(gbkData))
 }
+
+func TestIsASCII(t *testing.T) {
+	assert := internal.NewAssert(t, "TestIsASCII")
+
+	assert.Equal(true, IsASCII("ABC"))
+	assert.Equal(true, IsASCII("123"))
+	assert.Equal(true, IsASCII(""))
+	assert.Equal(false, IsASCII("😄"))
+	assert.Equal(false, IsASCII("你好"))
+}
+
+func TestIsPrintable(t *testing.T) {
+	assert := internal.NewAssert(t, "TestIsPrintable")
+
+	assert.Equal(true, IsPrintable("ABC"))
+	assert.Equal(true, IsPrintable("{id: 123}"))
+	assert.Equal(true, IsPrintable(""))
+	assert.Equal(true, IsPrintable("😄"))
+	assert.Equal(false, IsPrintable("\u0000"))
+}
Author	SHA1	Message	Date
dudaodong	8bdd46bda4	doc: add play ground demo	2023-04-03 10:33:57 +08:00
dudaodong	e29b56c3c3	release v2.1.18	2023-04-03 10:12:50 +08:00
dudaodong	c357fc68c8	doc: update readme file for new feature	2023-04-03 10:12:13 +08:00
dudaodong	bc25e7a037	feat: add IsPrintable	2023-03-31 12:00:32 +08:00
dudaodong	217350042b	feat: add RemoveNonPrintable	2023-03-30 14:52:32 +08:00
dudaodong	e56a8a1ef5	feat: add IsASCII	2023-03-30 14:41:32 +08:00
dudaodong	6453f755a6	doc: add doc for IsPrime	2023-03-30 14:09:05 +08:00
dudaodong	027abd6ad5	feat: add IsPrime	2023-03-30 11:54:20 +08:00