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

doc: update doc for GetOrDefault

This commit is contained in:
dudaodong
2024-09-10 15:54:54 +08:00
6 changed files with 116 additions and 2 deletions

View File

@@ -1016,6 +1016,9 @@ import "github.com/duke-git/lancet/v2/maputil"
- **<big>SortByKey</big>** : sorts the map by its keys and returns a new map with sorted keys.
[[doc](https://github.com/duke-git/lancet/blob/main/docs/en/api/packages/maputil.md#SortByKey)]
[[play](todo)]
- **<big>GetOrDefault</big>** : returns the value of the given key or a default value if the key is not present.
[[doc](https://github.com/duke-git/lancet/blob/main/docs/en/api/packages/maputil.md#GetOrDefault)]
[[play](todo)]
<h3 id="mathutil"> 13. Mathutil package implements some functions for math calculation. &nbsp; &nbsp; &nbsp; &nbsp;<a href="#index">index</a></h3>

View File

@@ -1018,7 +1018,9 @@ import "github.com/duke-git/lancet/v2/maputil"
- **<big>SortByKey</big>** : 对传入的map根据key进行排序。
[[doc](https://github.com/duke-git/lancet/blob/main/docs/api/packages/maputil.md#SortByKey)]
[[play](todo)]
- **<big>GetOrDefault</big>** : 返回给定键的值,如果键不存在,则返回默认值。
[[doc](https://github.com/duke-git/lancet/blob/main/docs/api/packages/maputil.md#GetOrDefault)]
[[play](todo)]
<h3 id="mathutil"> 13. mathutil 包实现了一些数学计算的函数。&nbsp; &nbsp; &nbsp; &nbsp;<a href="#index">回到目录</a></h3>

View File

@@ -77,6 +77,7 @@ import (
- [ConcurrentMap_Range](#ConcurrentMap_Range)
- [GetOrSet](#GetOrSet)
- [SortByKey](#SortByKey)
- [GetOrDefault](#GetOrDefault)
<div STYLE="page-break-after: always;"></div>
@@ -2263,4 +2264,44 @@ func main() {
// Output:
// map[1:a 2:b 3:c 4:d]
}
```
### <span id="GetOrDefault">GetOrDefault</span>
<p>返回给定键的值,如果键不存在,则返回默认值。</p>
<b>函数签名:</b>
```go
func GetOrDefault[K comparable, V any](m map[K]V, key K, defaultValue V) V
```
<b>示例:<span style="float:right;display:inline-block;">[运行](todo)</span></b>
```go
package main
import (
"fmt"
"github.com/duke-git/lancet/v2/maputil"
)
func main() {
m := map[int]string{
3: "c",
1: "a",
4: "d",
2: "b",
}
result1 := maputil.GetOrDefault(m, 1, "default")
result2 := maputil.GetOrDefault(m, 6, "default")
fmt.Println(result1)
fmt.Println(result2)
// Output:
// a
// default
}
```

View File

@@ -78,7 +78,7 @@ import (
- [ConcurrentMap_Range](#ConcurrentMap_Range)
- [GetOrSet](#GetOrSet)
- [SortByKey](#SortByKey)
- [GetOrDefault](#GetOrDefault)
<div STYLE="page-break-after: always;"></div>
@@ -2281,4 +2281,44 @@ func main() {
// Output:
// map[1:a 2:b 3:c 4:d]
}
```
### <span id="GetOrDefault">GetOrDefault</span>
<p>returns the value of the given key or a default value if the key is not present.</p>
<b>Signature:</b>
```go
func GetOrDefault[K comparable, V any](m map[K]V, key K, defaultValue V) V
```
<b>Example:<span style="float:right;display:inline-block;">[运行](todo)</span></b>
```go
package main
import (
"fmt"
"github.com/duke-git/lancet/v2/maputil"
)
func main() {
m := map[int]string{
3: "c",
1: "a",
4: "d",
2: "b",
}
result1 := maputil.GetOrDefault(m, 1, "default")
result2 := maputil.GetOrDefault(m, 6, "default")
fmt.Println(result1)
fmt.Println(result2)
// Output:
// a
// default
}
```

View File

@@ -657,3 +657,12 @@ func convertMap(src reflect.Value, dst reflect.Value) error {
return nil
}
// GetOrDefault returns the value of the given key or a default value if the key is not present.
// Play: todo
func GetOrDefault[K comparable, V any](m map[K]V, key K, defaultValue V) V {
if v, ok := m[key]; ok {
return v
}
return defaultValue
}

View File

@@ -869,3 +869,22 @@ func TestBaseType(t *testing.T) {
MapTo(tc["u64"], &number)
assert.EqualValues(64, number)
}
func TestGetOrDefault(t *testing.T) {
t.Parallel()
assert := internal.NewAssert(t, "GetOrDefault")
m1 := map[int]string{
3: "c",
1: "a",
4: "d",
2: "b",
}
result1 := GetOrDefault(m1, 1, "123")
assert.Equal("a", result1)
result2 := GetOrDefault(m1, 5, "123")
assert.Equal("123", result2)
}