1
0
mirror of https://github.com/duke-git/lancet.git synced 2026-02-12 16:52:29 +08:00

doc: update doc for random package

This commit is contained in:
dudaodong
2023-12-07 19:13:05 +08:00
parent 6fe8a9efe7
commit 52b8ea8166
3 changed files with 59 additions and 5 deletions

View File

@@ -218,6 +218,32 @@ func main() {
} }
``` ```
### <span id="RandSymbolChar">RandSymbolChar</span>
<p>生成给定长度的随机符号字符串. 符号字符包括: !@#$%^&*()_+-=[]{}|;':\",./<>?。</p>
<b>函数签名:</b>
```go
func RandSymbolChar(length int) string
```
<b>示例:</b>
```go
package main
import (
"fmt"
"github.com/duke-git/lancet/v2/random"
)
func main() {
randStr := random.RandSymbolChar(6)
fmt.Println(randStr) //@#(_")
}
```
### <span id="UUIdV4">UUIdV4</span> ### <span id="UUIdV4">UUIdV4</span>
<p>生成UUID v4字符串</p> <p>生成UUID v4字符串</p>

View File

@@ -29,6 +29,7 @@ import (
- [RandLower](#RandLower) - [RandLower](#RandLower)
- [RandNumeral](#RandNumeral) - [RandNumeral](#RandNumeral)
- [RandNumeralOrLetter](#RandNumeralOrLetter) - [RandNumeralOrLetter](#RandNumeralOrLetter)
- [RandSymbolChar](#RandSymbolChar)
- [UUIdV4](#UUIdV4) - [UUIdV4](#UUIdV4)
- [RandUniqueIntSlice](#RandUniqueIntSlice) - [RandUniqueIntSlice](#RandUniqueIntSlice)
@@ -218,6 +219,32 @@ func main() {
} }
``` ```
### <span id="RandSymbolChar">RandSymbolChar</span>
<p>Generate a random symbol char of specified length. Symbol chars: !@#$%^&*()_+-=[]{}|;':\",./<>?.</p>
<b>Signature:</b>
```go
func RandSymbolChar(length int) string
```
<b>Example:</b>
```go
package main
import (
"fmt"
"github.com/duke-git/lancet/v2/random"
)
func main() {
randStr := random.RandSymbolChar(6)
fmt.Println(randStr) //@#(_")
}
```
### <span id="UUIdV4">UUIdV4</span> ### <span id="UUIdV4">UUIdV4</span>
<p>Generate a random UUID of version 4 according to RFC 4122.</p> <p>Generate a random UUID of version 4 according to RFC 4122.</p>

View File

@@ -53,19 +53,19 @@ func RandBytes(length int) []byte {
return b return b
} }
// RandString generate random string of specified length. // RandString generate random alpha string of specified length.
// Play: https://go.dev/play/p/W2xvRUXA7Mi // Play: https://go.dev/play/p/W2xvRUXA7Mi
func RandString(length int) string { func RandString(length int) string {
return random(Letters, length) return random(Letters, length)
} }
// RandUpper generate a random upper case string. // RandUpper generate a random upper case string of specified length.
// Play: https://go.dev/play/p/29QfOh0DVuh // Play: https://go.dev/play/p/29QfOh0DVuh
func RandUpper(length int) string { func RandUpper(length int) string {
return random(UpperLetters, length) return random(UpperLetters, length)
} }
// RandLower generate a random lower case string. // RandLower generate a random lower case string of specified length.
// Play: https://go.dev/play/p/XJtZ471cmtI // Play: https://go.dev/play/p/XJtZ471cmtI
func RandLower(length int) string { func RandLower(length int) string {
return random(LowwerLetters, length) return random(LowwerLetters, length)
@@ -77,13 +77,14 @@ func RandNumeral(length int) string {
return random(Numeral, length) return random(Numeral, length)
} }
// RandNumeralOrLetter generate a random numeral or letter string. // RandNumeralOrLetter generate a random numeral or alpha string of specified length.
// Play: https://go.dev/play/p/19CEQvpx2jD // Play: https://go.dev/play/p/19CEQvpx2jD
func RandNumeralOrLetter(length int) string { func RandNumeralOrLetter(length int) string {
return random(Numeral+Letters, length) return random(Numeral+Letters, length)
} }
// RandSymbolChar generate a random symbol char(!@#$%^&*()_+-=[]{}|;':\",./<>?). // RandSymbolChar generate a random symbol char of specified length.
// symbol chars: !@#$%^&*()_+-=[]{}|;':\",./<>?.
// Play: todo // Play: todo
func RandSymbolChar(length int) string { func RandSymbolChar(length int) string {
return random(SymbolChars, length) return random(SymbolChars, length)