git/lancet
1
0
Fork 0
mirror of https://github.com/duke-git/lancet.git synced 2026-02-08 22:52:29 +08:00
Code Issues Projects Releases Wiki Activity

doc: update doc for v2.3.1

Browse Source
This commit is contained in:
dudaodong
2024-05-14 11:25:01 +08:00
parent 967e6a3493
commit 6e0498514c
8 changed files with 216 additions and 121 deletions
Download Patch File Download Diff File Expand all files Collapse all files

141
docs/api/packages/maputil.md
View File

@@ -948,14 +948,6 @@ func main() {
<p>检查map是否包含某个key。用于代替以下样板代码:</p>
```go
_, haskey := amap["baz"];
if haskey {
fmt.Println("map has key baz")
}
```
<b>函数签名:</b>
```go
@@ -990,6 +982,49 @@ func main() {
}
```
### <span id="MapToStruct">MapToStruct</span>
<p>将map转成struct。</p>
<b>函数签名:</b>
```go
func MapToStruct(m map[string]any, structObj any) error
```
<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/7wYyVfX38Dp)</span></b>
```go
package main
import (
"fmt"
"github.com/duke-git/lancet/v2/maputil"
)
func main() {
personReqMap := map[string]any{
"name": "Nothin",
"max_age": 35,
"page": 1,
"pageSize": 10,
}
type PersonReq struct {
Name string `json:"name"`
MaxAge int `json:"max_age"`
Page int `json:"page"`
PageSize int `json:"pageSize"`
}
var personReq PersonReq
_ = maputil.MapToStruct(personReqMap, &personReq)
fmt.Println(personReq)
// Output:
// {Nothin 35 1 10}
}
```
### <span id="ToSortedSlicesDefault">ToSortedSlicesDefault</span>
<p>将map的key和value转化成两个根据key的值从小到大排序的切片，value切片中元素的位置与key对应。</p>
@@ -1000,7 +1035,7 @@ func main() {
func ToSortedSlicesDefault[K constraints.Ordered, V any](m map[K]V) ([]K, []V)
```
<b>示例:<span style="float:right;display:inline-block;">[运行](todo)</span></b>
<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/43gEM2po-qy)</span></b>
```go
package main
@@ -1012,19 +1047,19 @@ import (
func main() {
m := map[int]string{
1: "a",
3: "c",
2: "b",
}
1: "a",
3: "c",
2: "b",
}
keys, values := ToSortedSlicesDefault(m)
keys, values := ToSortedSlicesDefault(m)
fmt.Println(keys)
fmt.Println(values)
fmt.Println(keys)
fmt.Println(values)
// Output:
// [1 2 3]
// [a b c]
// Output:
// [1 2 3]
// [a b c]
}
```
@@ -1038,7 +1073,7 @@ func main() {
func ToSortedSlicesWithComparator[K comparable, V any](m map[K]V, comparator func(a, b K) bool) ([]K, []V)
```
<b>示例:<span style="float:right;display:inline-block;">[运行](todo)</span></b>
<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/0nlPo6YLdt3)</span></b>
```go
package main
@@ -1050,35 +1085,35 @@ import (
func main() {
m1 := map[time.Time]string{
time.Date(2024, 3, 31, 0, 0, 0, 0, time.UTC): "today",
time.Date(2024, 3, 30, 0, 0, 0, 0, time.UTC): "yesterday",
time.Date(2024, 4, 1, 0, 0, 0, 0, time.UTC): "tomorrow",
}
time.Date(2024, 3, 31, 0, 0, 0, 0, time.UTC): "today",
time.Date(2024, 3, 30, 0, 0, 0, 0, time.UTC): "yesterday",
time.Date(2024, 4, 1, 0, 0, 0, 0, time.UTC): "tomorrow",
}
keys1, values1 := ToSortedSlicesWithComparator(m1, func(a, b time.Time) bool {
return a.Before(b)
})
keys1, values1 := maputil.ToSortedSlicesWithComparator(m1, func(a, b time.Time) bool {
return a.Before(b)
})
m2 := map[int]string{
1: "a",
3: "c",
2: "b",
}
keys2, values2 := ToSortedSlicesWithComparator(m2, func(a, b int) bool {
return a > b
})
m2 := map[int]string{
1: "a",
3: "c",
2: "b",
}
keys2, values2 := maputil.ToSortedSlicesWithComparator(m2, func(a, b int) bool {
return a > b
})
fmt.Println(keys2)
fmt.Println(values2)
fmt.Println(keys2)
fmt.Println(values2)
fmt.Println(keys1)
fmt.Println(values1)
fmt.Println(keys1)
fmt.Println(values1)
// Output:
// [2024-03-30 00:00:00 +0000 UTC 2024-03-31 00:00:00 +0000 UTC 2024-04-01 00:00:00 +0000 UTC]
// [yesterday today tomorrow]
// [3 2 1]
// [c b a]
// Output:
// [3 2 1]
// [c b a]
// [2024-03-30 00:00:00 +0000 UTC 2024-03-31 00:00:00 +0000 UTC 2024-04-01 00:00:00 +0000 UTC]
// [yesterday today tomorrow]
}
```
@@ -1144,15 +1179,15 @@ func main() {
wg1.Wait()
var wg2 sync.WaitGroup
wg2.Add(5)
wg2.Add(5)
for j := 0; j < 5; j++ {
go func(n int) {
val, ok := cm.Get(fmt.Sprintf("%d", n))
fmt.Println(val, ok)
wg2.Done()
wg2.Done()
}(j)
}
wg2.Wait()
wg2.Wait()
// output: (order may change)
// 1 true
@@ -1198,15 +1233,15 @@ func main() {
wg1.Wait()
var wg2 sync.WaitGroup
wg2.Add(5)
wg2.Add(5)
for j := 0; j < 5; j++ {
go func(n int) {
val, ok := cm.Get(fmt.Sprintf("%d", n))
fmt.Println(val, ok)
wg2.Done()
wg2.Done()
}(j)
}
wg2.Wait()
wg2.Wait()
// output: (order may change)
// 1 true
@@ -1296,7 +1331,7 @@ func main() {
wg1.Wait()
var wg2 sync.WaitGroup
wg2.Add(5)
wg2.Add(5)
for j := 0; j < 5; j++ {
go func(n int) {
cm.Delete(fmt.Sprintf("%d", n))
@@ -1342,7 +1377,7 @@ func main() {
wg1.Wait()
var wg2 sync.WaitGroup
wg2.Add(5)
wg2.Add(5)
for j := 0; j < 5; j++ {
go func(n int) {
val, ok := cm.GetAndDelete(fmt.Sprintf("%d", n))
@@ -1392,7 +1427,7 @@ func main() {
wg1.Wait()
var wg2 sync.WaitGroup
wg2.Add(5)
wg2.Add(5)
for j := 0; j < 5; j++ {
go func(n int) {

6
docs/api/packages/slice.md
View File

@@ -2615,7 +2615,7 @@ func main() {
func Break[T any](values []T, predicate func(T) bool) ([]T, []T)
```
<b>示例:</b>
<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/yLYcBTyeQIz)</span></b>
```go
import (
@@ -2648,7 +2648,7 @@ func main() {
func RightPadding[T any](slice []T, paddingValue T, paddingLength int) []T
```
<b>示例:</b>
<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/0_2rlLEMBXL)</span></b>
```go
import (
@@ -2675,7 +2675,7 @@ func main() {
func LeftPadding[T any](slice []T, paddingValue T, paddingLength int) []T
```
<b>示例:</b>
<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/jlQVoelLl2k)</span></b>
```go
import (