mirror of
https://github.com/duke-git/lancet.git
synced 2026-02-15 02:02:27 +08:00
docs: add xerror package doc
This commit is contained in:
27
README.md
27
README.md
@@ -390,31 +390,14 @@ import "github.com/duke-git/lancet/validator"
|
|||||||
- [IsStrongPassword](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsStrongPassword)
|
- [IsStrongPassword](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsStrongPassword)
|
||||||
- [IsUrl](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsUrl)
|
- [IsUrl](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsUrl)
|
||||||
- [IsWeakPassword](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsWeakPassword)
|
- [IsWeakPassword](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsWeakPassword)
|
||||||
### 14. error helpers
|
### 14. xerror
|
||||||
|
xerror package implements helpers for errors.
|
||||||
- Contain functions to handle errors
|
|
||||||
- Usage: import "github.com/duke-git/lancet/xerror"
|
|
||||||
|
|
||||||
```go
|
```go
|
||||||
package main
|
import "github.com/duke-git/lancet/xerror"
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
"io/ioutil"
|
|
||||||
"log"
|
|
||||||
"github.com/duke-git/lancet/errors"
|
|
||||||
)
|
|
||||||
|
|
||||||
func main() {
|
|
||||||
x := Unwrap(strconv.Atoi("42")) // Unwrap if err is nil then it returns a valid value otherwise it panics
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
- Function list:
|
|
||||||
|
|
||||||
```go
|
|
||||||
Unwrap[T any](val T, err error) //if err is nil then it returns a valid value otherwise it panics
|
|
||||||
```
|
```
|
||||||
|
#### Function list:
|
||||||
|
- [Unwrap](https://github.com/duke-git/lancet/blob/main/docs/xerror.md#Unwrap)
|
||||||
|
|
||||||
|
|
||||||
## How to Contribute
|
## How to Contribute
|
||||||
|
|||||||
@@ -392,31 +392,15 @@ import "github.com/duke-git/lancet/validator"
|
|||||||
- [IsUrl](https://github.com/duke-git/lancet/blob/main/docs/validator_zh-CN.md#IsUrl)
|
- [IsUrl](https://github.com/duke-git/lancet/blob/main/docs/validator_zh-CN.md#IsUrl)
|
||||||
- [IsWeakPassword](https://github.com/duke-git/lancet/blob/main/docs/validator_zh-CN.md#IsWeakPassword)
|
- [IsWeakPassword](https://github.com/duke-git/lancet/blob/main/docs/validator_zh-CN.md#IsWeakPassword)
|
||||||
|
|
||||||
### error helpers
|
validator.md#IsWeakPassword)
|
||||||
|
### 14. xerror
|
||||||
- 错误处理函数
|
xerror包实现一些错误处理函数
|
||||||
- Usage: import "github.com/duke-git/lancet/xerror"
|
|
||||||
|
|
||||||
```go
|
```go
|
||||||
package main
|
import "github.com/duke-git/lancet/xerror"
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
"io/ioutil"
|
|
||||||
"log"
|
|
||||||
"github.com/duke-git/lancet/errors"
|
|
||||||
)
|
|
||||||
|
|
||||||
func main() {
|
|
||||||
x := Unwrap(strconv.Atoi("42"))
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
- Function list:
|
|
||||||
|
|
||||||
```go
|
|
||||||
Unwrap[T any](val T, err error) //如果err是nil,返回有效的val值。否则, panics
|
|
||||||
```
|
```
|
||||||
|
#### 函数列表:
|
||||||
|
- [Unwrap](https://github.com/duke-git/lancet/blob/main/docs/xerror_zh-CN.md#Unwrap)
|
||||||
|
|
||||||
## 如何贡献代码
|
## 如何贡献代码
|
||||||
|
|
||||||
|
|||||||
57
docs/xerror.md
Normal file
57
docs/xerror.md
Normal file
@@ -0,0 +1,57 @@
|
|||||||
|
# Xerror
|
||||||
|
Package xerror implements helpers for errors.
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## Source:
|
||||||
|
|
||||||
|
- [https://github.com/duke-git/lancet/blob/main/xerror/xerror.go](https://github.com/duke-git/lancet/blob/main/xerror/xerror.go)
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## Usage:
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"github.com/duke-git/lancet/xerror"
|
||||||
|
)
|
||||||
|
```
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## Index
|
||||||
|
- [Unwrap](#Unwrap)
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## Documentation
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="Unwrap">Unwrap</span>
|
||||||
|
<p>Unwrap if err is nil then it returns a valid value. If err is not nil, Unwrap panics with err.</p>
|
||||||
|
|
||||||
|
<b>Signature:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func Unwrap[T any](val T, err error) T
|
||||||
|
```
|
||||||
|
<b>Example:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/xerror"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
_, err := strconv.Atoi("4o2")
|
||||||
|
defer func() {
|
||||||
|
v := recover()
|
||||||
|
fmt.Println(err.Error()) // err.Error() == v.(*strconv.NumError).Error()
|
||||||
|
}()
|
||||||
|
|
||||||
|
xerror.Unwrap(strconv.Atoi("4o2"))
|
||||||
|
}
|
||||||
|
```
|
||||||
57
docs/xerror_zh-CN.md
Normal file
57
docs/xerror_zh-CN.md
Normal file
@@ -0,0 +1,57 @@
|
|||||||
|
# Xerror
|
||||||
|
xerror错误处理逻辑封装
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## 源码:
|
||||||
|
|
||||||
|
- [https://github.com/duke-git/lancet/blob/main/xerror/xerror.go](https://github.com/duke-git/lancet/blob/main/xerror/xerror.go)
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## 用法:
|
||||||
|
```go
|
||||||
|
import (
|
||||||
|
"github.com/duke-git/lancet/xerror"
|
||||||
|
)
|
||||||
|
```
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## 目录
|
||||||
|
- [Unwrap](#Unwrap)
|
||||||
|
|
||||||
|
<div STYLE="page-break-after: always;"></div>
|
||||||
|
|
||||||
|
## 文档
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### <span id="Unwrap">Unwrap</span>
|
||||||
|
<p>如果err为nil则展开,则它返回一个有效值。 如果err不是nil则Unwrap使用err发生恐慌。</p>
|
||||||
|
|
||||||
|
<b>函数签名:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
func Unwrap[T any](val T, err error) T
|
||||||
|
```
|
||||||
|
<b>例子:</b>
|
||||||
|
|
||||||
|
```go
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"github.com/duke-git/lancet/xerror"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
_, err := strconv.Atoi("4o2")
|
||||||
|
defer func() {
|
||||||
|
v := recover()
|
||||||
|
fmt.Println(err.Error()) // err.Error() == v.(*strconv.NumError).Error()
|
||||||
|
}()
|
||||||
|
|
||||||
|
xerror.Unwrap(strconv.Atoi("4o2"))
|
||||||
|
}
|
||||||
|
```
|
||||||
Reference in New Issue
Block a user