From 8be7b3e39687426883876bd72078e49cd771b50c Mon Sep 17 00:00:00 2001 From: dudaodong Date: Thu, 18 Jul 2024 10:12:16 +0800 Subject: [PATCH] rename UnwrapOr --- README.md | 2 +- docs/api/packages/pointer.md | 28 ++++++++++++++-------------- docs/en/api/packages/pointer.md | 28 ++++++++++++++-------------- pointer/pointer_test.go | 4 ++-- 4 files changed, 31 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index 7d9a3d0..3870beb 100644 --- a/README.md +++ b/README.md @@ -1125,7 +1125,7 @@ import "github.com/duke-git/lancet/v2/pointer" - **Unwrap** : return the value from the pointer. [[doc](https://github.com/duke-git/lancet/blob/main/docs/en/api/packages/pointer.md#Unwrap)] [[play](https://go.dev/play/p/cgeu3g7cjWb)] -- **UnwarpOr** : UnwarpOr returns the value from the pointer or fallback if the pointer is nil. +- **UnwrapOr** : UnwrapOr returns the value from the pointer or fallback if the pointer is nil. [[doc](https://github.com/duke-git/lancet/blob/main/docs/en/api/packages/pointer.md#UnwrapOr)] [[play](https://go.dev/play/p/mmNaLC38W8C)] - **UnwarpOrDefault** : UnwarpOrDefault returns the value from the pointer or the default value if the pointer is nil. diff --git a/docs/api/packages/pointer.md b/docs/api/packages/pointer.md index 8fa147f..e6f1a06 100644 --- a/docs/api/packages/pointer.md +++ b/docs/api/packages/pointer.md @@ -25,8 +25,8 @@ import ( - [Of](#Of) - [Unwrap](#Unwrap) - [ExtractPointer](#ExtractPointer) -- [UnwarpOr](#UnwarpOr) -- [UnwarpOrDefault](#UnwarpOrDefault) +- [UnwrapOr](#UnwrapOr) +- [UnwrapOrDefault](#UnwrapOrDefault)
@@ -136,14 +136,14 @@ func main() { } ``` -### UnwarpOr +### UnwrapOr

返回指针的值，如果指针为零值，则返回fallback。

函数签名: ```go -UnwarpOr[T any](p *T, fallback T) T +UnwrapOr[T any](p *T, fallback T) T ``` 示例:[运行](https://go.dev/play/p/mmNaLC38W8C) @@ -163,10 +163,10 @@ func main() { var c *int var d *string - result1 := pointer.UnwarpOr(&a, 456) - result2 := pointer.UnwarpOr(&b, "abc") - result3 := pointer.UnwarpOr(c, 456) - result4 := pointer.UnwarpOr(d, "def") + result1 := pointer.UnwrapOr(&a, 456) + result2 := pointer.UnwrapOr(&b, "abc") + result3 := pointer.UnwrapOr(c, 456) + result4 := pointer.UnwrapOr(d, "def") fmt.Println(result1) fmt.Println(result2) @@ -181,14 +181,14 @@ func main() { } ``` -### UnwarpOrDefault +### UnwrapOrDefault

返回指针的值，如果指针为零值，则返回相应零值。

函数签名: ```go -UnwarpOrDefault[T any](p *T) T +UnwrapOrDefault[T any](p *T) T ``` 示例:[运行](https://go.dev/play/p/ZnGIHf8_o4E) @@ -208,10 +208,10 @@ func main() { var c *int var d *string - result1 := pointer.UnwarpOrDefault(&a) - result2 := pointer.UnwarpOrDefault(&b) - result3 := pointer.UnwarpOrDefault(c) - result4 := pointer.UnwarpOrDefault(d) + result1 := pointer.UnwrapOrDefault(&a) + result2 := pointer.UnwrapOrDefault(&b) + result3 := pointer.UnwrapOrDefault(c) + result4 := pointer.UnwrapOrDefault(d) fmt.Println(result1) fmt.Println(result2) diff --git a/docs/en/api/packages/pointer.md b/docs/en/api/packages/pointer.md index a3d6838..2434d40 100644 --- a/docs/en/api/packages/pointer.md +++ b/docs/en/api/packages/pointer.md @@ -24,8 +24,8 @@ import ( - [Of](#Of) - [Unwrap](#Unwrap) -- [UnwarpOr](#UnwarpOr) -- [UnwarpOrDefault](#UnwarpOrDefault) +- [UnwrapOr](#UnwrapOr) +- [UnwrapOrDefault](#UnwrapOrDefault) - [ExtractPointer](#ExtractPointer)
@@ -103,13 +103,13 @@ func main() { ``` -### UnwarpOr +### UnwrapOr

Returns the value from the pointer or fallback if the pointer is nil.

Signature: ```go -UnwarpOr[T any](p *T, fallback T) T +UnwrapOr[T any](p *T, fallback T) T ``` Example:[Run](https://go.dev/play/p/mmNaLC38W8C) @@ -129,10 +129,10 @@ func main() { var c *int var d *string - result1 := pointer.UnwarpOr(&a, 456) - result2 := pointer.UnwarpOr(&b, "abc") - result3 := pointer.UnwarpOr(c, 456) - result4 := pointer.UnwarpOr(d, "def") + result1 := pointer.UnwrapOr(&a, 456) + result2 := pointer.UnwrapOr(&b, "abc") + result3 := pointer.UnwrapOr(c, 456) + result4 := pointer.UnwrapOr(d, "def") fmt.Println(result1) fmt.Println(result2) @@ -148,13 +148,13 @@ func main() { ``` -### UnwarpOrDefault +### UnwrapOrDefault

Returns the value from the pointer or the default value if the pointer is nil.

Signature: ```go -UnwarpOrDefault[T any](p *T) T +UnwrapOrDefault[T any](p *T) T ``` Example:[Run](https://go.dev/play/p/ZnGIHf8_o4E) @@ -174,10 +174,10 @@ func main() { var c *int var d *string - result1 := pointer.UnwarpOrDefault(&a) - result2 := pointer.UnwarpOrDefault(&b) - result3 := pointer.UnwarpOrDefault(c) - result4 := pointer.UnwarpOrDefault(d) + result1 := pointer.UnwrapOrDefault(&a) + result2 := pointer.UnwrapOrDefault(&b) + result3 := pointer.UnwrapOrDefault(c) + result4 := pointer.UnwrapOrDefault(d) fmt.Println(result1) fmt.Println(result2) diff --git a/pointer/pointer_test.go b/pointer/pointer_test.go index 7415937..939ce38 100644 --- a/pointer/pointer_test.go +++ b/pointer/pointer_test.go @@ -47,10 +47,10 @@ func TestUnwarpOr(t *testing.T) { assert.Equal("def", UnwarpOr(d, "def")) } -func TestUnwarpOrDefault(t *testing.T) { +func TestUnwrapOrDefault(t *testing.T) { t.Parallel() - assert := internal.NewAssert(t, "TestUnwarpOrDefault") + assert := internal.NewAssert(t, "TestUnwrapOrDefault") a := 123 b := "abc"