doc: fix ExampleXError_StackTrace bug

docs/xerror.md

@@ -22,20 +22,40 @@ import (
 
 ## Index
 
+-   [New](#New)
+-   [Wrap](#Wrap)
 -   [Unwrap](#Unwrap)
+-   [XError_Wrap](#XError_Wrap)
+-   [XError_Unwrap](#XError_Unwrap)
+-   [XError_With](#XError_With)
+-   [XError_Is](#XError_Is)
+-   [XError_Id](#XError_Id)
+-   [XError_Values](#XError_Values)
+-   [XError_StackTrace](#XError_StackTrace)
+-   [XError_Info](#XError_Info)
+-   [XError_Error](#XError_Error)
+-   [TryUnwrap](#TryUnwrap)
 
 <div STYLE="page-break-after: always;"></div>
 
 ## Documentation
 
-### <span id="Unwrap">Unwrap</span>
+### <span id="New">New</span>
 
-<p>Unwrap if err is nil then it returns a valid value. If err is not nil, Unwrap panics with err.</p>
+<p>Creates a new XError pointer instance with message.</p>
 
 <b>Signature:</b>
 
 ```go
-func Unwrap[T any](val T, err error) T
+type XError struct {
+    id      string
+    message string
+    stack   *stack
+    cause   error
+    values  map[string]any
+}
+
+func New(format string, args ...any) *XError
 ```
 
 <b>Example:</b>
@@ -49,7 +69,407 @@ import (
 )
 
 func main() {
-    result1 := xerror.Unwrap(strconv.Atoi("42"))
+    err := xerror.New("error")
+    fmt.Println(err.Error())
+
+    // Output:
+    // error
+}
+```
+
+### <span id="Wrap">Wrap</span>
+
+<p>Creates a new XError pointer instance based on error object, and add message.</p>
+
+<b>Signature:</b>
+
+```go
+func Wrap(cause error, message ...any) *XError
+```
+
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/xerror"
+)
+
+func main() {
+    err := xerror.New("wrong password")
+    wrapErr := xerror.Wrap(err, "error")
+
+    fmt.Println(wrapErr.Error())
+
+    // Output:
+    // error: wrong password
+}
+```
+
+### <span id="Unwrap">Unwrap</span>
+
+<p>Returns unwrapped XError from err by errors.As. If no XError, returns nil.</p>
+
+<b>Signature:</b>
+
+```go
+func Unwrap(err error) *XError
+```
+
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/pkg/errors"
+    "github.com/duke-git/lancet/v2/xerror"
+)
+
+func main() {
+    err1 := xerror.New("error").With("level", "high")
+    wrapErr := errors.Wrap(err1, "oops")
+
+    err := xerror.Unwrap(err1)
+
+    values := err.Values()
+    fmt.Println(values["level"])
+
+    // Output:
+    // high
+}
+```
+
+### <span id="XError_Wrap">XError_Wrap</span>
+
+<p>Creates a new XError and copy message and id to new one.</p>
+
+<b>Signature:</b>
+
+```go
+func (e *XError) Wrap(cause error) *XError
+```
+
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/xerror"
+)
+
+func main() {
+    err := xerror.New("wrong password")
+    wrapErr := xerror.Wrap(err, "error")
+
+    fmt.Println(wrapErr.Error())
+
+    // Output:
+    // error: wrong password
+}
+```
+
+### <span id="XError_Unwrap">XError_Unwrap</span>
+
+<p>Compatible with github.com/pkg/errors.</p>
+
+<b>Signature:</b>
+
+```go
+func (e *XError) Unwrap() error
+```
+
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/xerror"
+)
+
+func main() {
+    err1 := xerror.New("error").With("level", "high")
+    err2 := err1.Wrap(errors.New("invalid username"))
+
+    err := err2.Unwrap()
+
+    fmt.Println(err.Error())
+
+    // Output:
+    // invalid username
+}
+```
+
+### <span id="XError_With">XError_With</span>
+
+<p>Adds key and value related to the XError object.</p>
+
+<b>Signature:</b>
+
+```go
+func (e *XError) With(key string, value any) *XError
+```
+
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/xerror"
+)
+
+func main() {
+    err := xerror.New("error").With("level", "high")
+
+    errLevel := err.Values()["level"]
+
+    fmt.Println(errLevel)
+
+    // Output:
+    // high
+}
+```
+
+### <span id="XError_Id">XError_Id</span>
+
+<p>Sets XError object id to check equality in XError.Is.</p>
+
+<b>Signature:</b>
+
+```go
+func (e *XError) Id(id string) *XError
+```
+
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/xerror"
+)
+
+func main() {
+    err1 := xerror.New("error").Id("e001")
+    err2 := xerror.New("error").Id("e001")
+    err3 := xerror.New("error").Id("e003")
+
+    equal := err1.Is(err2)
+    notEqual := err1.Is(err3)
+
+    fmt.Println(equal)
+    fmt.Println(notEqual)
+
+    // Output:
+    // true
+    // false
+}
+```
+
+### <span id="XError_Is">XError_Is</span>
+
+<p>Checks if target error is XError and Error.id of two errors are matched.</p>
+
+<b>Signature:</b>
+
+```go
+func (e *XError) Is(target error) bool
+```
+
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/xerror"
+)
+
+func main() {
+    err1 := xerror.New("error").Id("e001")
+    err2 := xerror.New("error").Id("e001")
+    err3 := xerror.New("error").Id("e003")
+
+    equal := err1.Is(err2)
+    notEqual := err1.Is(err3)
+
+    fmt.Println(equal)
+    fmt.Println(notEqual)
+
+    // Output:
+    // true
+    // false
+}
+```
+
+### <span id="XError_Values">XError_Values</span>
+
+<p>Returns map of key and value that is set by With. All wrapped xerror.XError key and values will be merged. Key and values of wrapped error is overwritten by upper xerror.XError.</p>
+
+<b>Signature:</b>
+
+```go
+func (e *XError) Values() map[string]any
+```
+
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/xerror"
+)
+
+func main() {
+    err := xerror.New("error").With("level", "high")
+
+    errLevel := err.Values()["level"]
+
+    fmt.Println(errLevel)
+
+    // Output:
+    // high
+}
+```
+
+
+### <span id="XError_StackTrace">XError_StackTrace</span>
+
+<p>Returns stack trace which is compatible with pkg/errors.</p>
+
+<b>Signature:</b>
+
+```go
+func (e *XError) StackTrace() StackTrace
+```
+
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/xerror"
+)
+
+func main() {
+    err := xerror.New("error")
+
+    stacks := err.Stacks()
+
+    fmt.Println(stacks[0].Func)
+    fmt.Println(stacks[0].Line)
+
+    containFile := strings.Contains(stacks[0].File, "xxx.go")
+    fmt.Println(containFile)
+}
+```
+
+
+### <span id="XError_Info">XError_Info</span>
+
+<p>Returns information of xerror, which can be printed.</p>
+
+<b>Signature:</b>
+
+```go
+func (e *XError) Info() *errInfo
+```
+
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/xerror"
+)
+
+func main() {
+    cause := errors.New("error")
+    err := xerror.Wrap(cause, "invalid username").Id("e001").With("level", "high")
+
+    errInfo := err.Info()
+
+    fmt.Println(errInfo.Id)
+    fmt.Println(errInfo.Cause)
+    fmt.Println(errInfo.Values["level"])
+    fmt.Println(errInfo.Message)
+
+    // Output:
+    // e001
+    // error
+    // high
+    // invalid username
+}
+```
+
+
+### <span id="XError_Error">XError_Error</span>
+
+<p>Error implements standard error interface.</p>
+
+<b>Signature:</b>
+
+```go
+func (e *XError) Error() string
+```
+
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/xerror"
+)
+
+func main() {
+    err := New("error")
+    fmt.Println(err.Error())
+
+    // Output:
+    // error
+}
+```
+### <span id="TryUnwrap">TryUnwrap</span>
+
+<p>TryUnwrap 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 TryUnwrap[T any](val T, err error) T
+```
+
+<b>Example:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/xerror"
+)
+
+func main() {
+    result1 := xerror.TryUnwrap(strconv.Atoi("42"))
     fmt.Println(result1)
 
     _, err := strconv.Atoi("4o2")
@@ -59,7 +479,7 @@ func main() {
         fmt.Println(result2)
     }()
 
-    xerror.Unwrap(strconv.Atoi("4o2"))
+    xerror.TryUnwrap(strconv.Atoi("4o2"))
 
     // Output:
     // 42

docs/xerror_zh-CN.md

@@ -22,20 +22,40 @@ import (
 
 ## 目录
 
+-   [New](#New)
+-   [Wrap](#Wrap)
 -   [Unwrap](#Unwrap)
+-   [XError_Wrap](#XError_Wrap)
+-   [XError_Unwrap](#XError_Unwrap)
+-   [XError_With](#XError_With)
+-   [XError_Is](#XError_Is)
+-   [XError_Id](#XError_Id)
+-   [XError_Values](#XError_Values)
+-   [XError_StackTrace](#XError_StackTrace)
+-   [XError_Info](#XError_Info)
+-   [XError_Error](#XError_Error)
+-   [TryUnwrap](#TryUnwrap)
 
 <div STYLE="page-break-after: always;"></div>
 
 ## 文档
 
-### <span id="Unwrap">Unwrap</span>
+### <span id="New">New</span>
 
-<p>检查error, 如果err为nil则展开，则它返回一个有效值，如果err不是nil则Unwrap使用err发生panic。</p>
+<p>创建XError对象实例。</p>
 
 <b>函数签名:</b>
 
 ```go
-func Unwrap[T any](val T, err error) T
+type XError struct {
+    id      string
+    message string
+    stack   *stack
+    cause   error
+    values  map[string]any
+}
+
+func New(format string, args ...any) *XError
 ```
 
 <b>示例:</b>
@@ -49,7 +69,408 @@ import (
 )
 
 func main() {
-    result1 := xerror.Unwrap(strconv.Atoi("42"))
+    err := xerror.New("error")
+    fmt.Println(err.Error())
+
+    // Output:
+    // error
+}
+```
+
+### <span id="Wrap">Wrap</span>
+
+<p>根据error对象创建XError对象实例，可添加message。</p>
+
+<b>函数签名:</b>
+
+```go
+func Wrap(cause error, message ...any) *XError
+```
+
+<b>示例:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/xerror"
+)
+
+func main() {
+    err := xerror.New("wrong password")
+    wrapErr := xerror.Wrap(err, "error")
+
+    fmt.Println(wrapErr.Error())
+
+    // Output:
+    // error: wrong password
+}
+```
+
+### <span id="Unwrap">Unwrap</span>
+
+<p>从error对象中解构出XError。</p>
+
+<b>函数签名:</b>
+
+```go
+func Unwrap(err error) *XError
+```
+
+<b>示例:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/pkg/errors"
+    "github.com/duke-git/lancet/v2/xerror"
+)
+
+func main() {
+    err1 := xerror.New("error").With("level", "high")
+    wrapErr := errors.Wrap(err1, "oops")
+
+    err := xerror.Unwrap(err1)
+
+    values := err.Values()
+    fmt.Println(values["level"])
+
+    // Output:
+    // high
+}
+```
+
+### <span id="XError_Wrap">XError_Wrap</span>
+
+<p>创建新的XError对象并将消息和id复制到新的对象中。</p>
+
+<b>函数签名:</b>
+
+```go
+func (e *XError) Wrap(cause error) *XError
+```
+
+<b>示例:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/xerror"
+)
+
+func main() {
+    err := xerror.New("wrong password")
+    wrapErr := xerror.Wrap(err, "error")
+
+    fmt.Println(wrapErr.Error())
+
+    // Output:
+    // error: wrong password
+}
+```
+
+### <span id="XError_Unwrap">XError_Unwrap</span>
+
+<p>解构XEerror为error对象。适配github.com/pkg/errors。</p>
+
+<b>函数签名:</b>
+
+```go
+func (e *XError) Unwrap() error
+```
+
+<b>示例:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/xerror"
+)
+
+func main() {
+    err1 := xerror.New("error").With("level", "high")
+    err2 := err1.Wrap(errors.New("invalid username"))
+
+    err := err2.Unwrap()
+
+    fmt.Println(err.Error())
+
+    // Output:
+    // invalid username
+}
+```
+
+### <span id="XError_With">XError_With</span>
+
+<p>添加与XError对象的键和值。</p>
+
+<b>函数签名:</b>
+
+```go
+func (e *XError) With(key string, value any) *XError
+```
+
+<b>示例:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/xerror"
+)
+
+func main() {
+    err := xerror.New("error").With("level", "high")
+
+    errLevel := err.Values()["level"]
+
+    fmt.Println(errLevel)
+
+    // Output:
+    // high
+}
+```
+
+### <span id="XError_Id">XError_Id</span>
+
+<p>设置XError对象的id.</p>
+
+<b>函数签名:</b>
+
+```go
+func (e *XError) Id(id string) *XError
+```
+
+<b>示例:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/xerror"
+)
+
+func main() {
+    err1 := xerror.New("error").Id("e001")
+    err2 := xerror.New("error").Id("e001")
+    err3 := xerror.New("error").Id("e003")
+
+    equal := err1.Is(err2)
+    notEqual := err1.Is(err3)
+
+    fmt.Println(equal)
+    fmt.Println(notEqual)
+
+    // Output:
+    // true
+    // false
+}
+```
+
+### <span id="XError_Is">XError_Is</span>
+
+<p>检查目标error是否为XError，两个错误中的error.id是否匹配。</p>
+
+<b>函数签名:</b>
+
+```go
+func (e *XError) Is(target error) bool
+```
+
+<b>示例:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/xerror"
+)
+
+func main() {
+    err1 := xerror.New("error").Id("e001")
+    err2 := xerror.New("error").Id("e001")
+    err3 := xerror.New("error").Id("e003")
+
+    equal := err1.Is(err2)
+    notEqual := err1.Is(err3)
+
+    fmt.Println(equal)
+    fmt.Println(notEqual)
+
+    // Output:
+    // true
+    // false
+}
+```
+
+### <span id="XError_Values">XError_Values</span>
+
+<p>返回由With设置的键和值的映射。将合并所有XError键和值。</p>
+
+<b>函数签名:</b>
+
+```go
+func (e *XError) Values() map[string]any
+```
+
+<b>示例:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/xerror"
+)
+
+func main() {
+    err := xerror.New("error").With("level", "high")
+
+    errLevel := err.Values()["level"]
+
+    fmt.Println(errLevel)
+
+    // Output:
+    // high
+}
+```
+
+
+### <span id="XError_StackTrace">XError_StackTrace</span>
+
+<p>返回与pkg/error兼容的堆栈信息</p>
+
+<b>函数签名:</b>
+
+```go
+func (e *XError) StackTrace() StackTrace
+```
+
+<b>示例:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/xerror"
+)
+
+func main() {
+    err := xerror.New("error")
+
+    stacks := err.Stacks()
+
+    fmt.Println(stacks[0].Func)
+    fmt.Println(stacks[0].Line)
+
+    containFile := strings.Contains(stacks[0].File, "xxx.go")
+    fmt.Println(containFile)
+}
+```
+
+
+### <span id="XError_Info">XError_Info</span>
+
+<p>返回可打印的XError对象信息。</p>
+
+<b>函数签名:</b>
+
+```go
+func (e *XError) Info() *errInfo
+```
+
+<b>示例:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/xerror"
+)
+
+func main() {
+    cause := errors.New("error")
+    err := xerror.Wrap(cause, "invalid username").Id("e001").With("level", "high")
+
+    errInfo := err.Info()
+
+    fmt.Println(errInfo.Id)
+    fmt.Println(errInfo.Cause)
+    fmt.Println(errInfo.Values["level"])
+    fmt.Println(errInfo.Message)
+
+    // Output:
+    // e001
+    // error
+    // high
+    // invalid username
+}
+```
+
+
+### <span id="XError_Error">XError_Error</span>
+
+<p>实现标准库的error接口。</p>
+
+<b>函数签名:</b>
+
+```go
+func (e *XError) Error() string
+```
+
+<b>示例:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/xerror"
+)
+
+func main() {
+    err := New("error")
+    fmt.Println(err.Error())
+
+    // Output:
+    // error
+}
+```
+
+### <span id="TryUnwrap">TryUnwrap</span>
+
+<p>检查error, 如果err为nil则展开，则它返回一个有效值，如果err不是nil则TryUnwrap使用err发生panic。</p>
+
+<b>函数签名:</b>
+
+```go
+func TryUnwrap[T any](val T, err error) T
+```
+
+<b>示例:</b>
+
+```go
+package main
+
+import (
+    "fmt"
+    "github.com/duke-git/lancet/v2/xerror"
+)
+
+func main() {
+    result1 := xerror.TryUnwrap(strconv.Atoi("42"))
     fmt.Println(result1)
 
     _, err := strconv.Atoi("4o2")
@@ -59,7 +480,7 @@ func main() {
         fmt.Println(result2)
     }()
 
-    xerror.Unwrap(strconv.Atoi("4o2"))
+    xerror.TryUnwrap(strconv.Atoi("4o2"))
 
     // Output:
     // 42

xerror/xerror_example_test.go

@@ -1,11 +1,142 @@
 package xerror
 
 import (
+	"errors"
 	"fmt"
 	"reflect"
 	"strconv"
+	"strings"
 )
 
+func ExampleNew() {
+	err := New("error")
+	fmt.Println(err.Error())
+
+	// Output:
+	// error
+}
+
+func ExampleWrap() {
+	err := New("wrong password")
+	wrapErr := Wrap(err, "error")
+
+	fmt.Println(wrapErr.Error())
+
+	// Output:
+	// error: wrong password
+}
+
+func ExampleXError_Wrap() {
+	err1 := New("error").With("level", "high")
+	err2 := err1.Wrap(errors.New("invalid username"))
+
+	fmt.Println(err2.Error())
+
+	// Output:
+	// error: invalid username
+}
+
+func ExampleXError_Unwrap() {
+	err1 := New("error").With("level", "high")
+	err2 := err1.Wrap(errors.New("invalid username"))
+
+	err := err2.Unwrap()
+
+	fmt.Println(err.Error())
+
+	// Output:
+	// invalid username
+}
+
+func ExampleXError_StackTrace() {
+	err := New("error")
+
+	stacks := err.Stacks()
+
+	fmt.Println(stacks[0].Func)
+	fmt.Println(stacks[0].Line)
+
+	containFile := strings.Contains(stacks[0].File, "xerror_example_test.go")
+	fmt.Println(containFile)
+
+	// Output:
+	// github.com/duke-git/lancet/v2/xerror.ExampleXError_StackTrace
+	// 52
+	// true
+}
+
+func ExampleXError_With() {
+	err := New("error").With("level", "high")
+
+	errLevel := err.Values()["level"]
+
+	fmt.Println(errLevel)
+
+	// Output:
+	// high
+}
+
+func ExampleXError_Id() {
+	err1 := New("error").Id("e001")
+	err2 := New("error").Id("e001")
+	err3 := New("error").Id("e003")
+
+	equal := err1.Is(err2)
+	notEqual := err1.Is(err3)
+
+	fmt.Println(equal)
+	fmt.Println(notEqual)
+
+	// Output:
+	// true
+	// false
+}
+
+func ExampleXError_Is() {
+	err1 := New("error").Id("e001")
+	err2 := New("error").Id("e001")
+	err3 := New("error").Id("e003")
+
+	equal := err1.Is(err2)
+	notEqual := err1.Is(err3)
+
+	fmt.Println(equal)
+	fmt.Println(notEqual)
+
+	// Output:
+	// true
+	// false
+}
+
+func ExampleXError_Values() {
+	err := New("error").With("level", "high")
+
+	errLevel := err.Values()["level"]
+
+	fmt.Println(errLevel)
+
+	// Output:
+	// high
+}
+
+func ExampleXError_Info() {
+	cause := errors.New("error")
+	err := Wrap(cause, "invalid username").Id("e001").With("level", "high")
+
+	errInfo := err.Info()
+
+	fmt.Println(errInfo.Id)
+	fmt.Println(errInfo.Cause)
+	fmt.Println(errInfo.Values["level"])
+	fmt.Println(errInfo.Message)
+
+	// Output:
+	// e001
+	// error
+	// high
+	// invalid username
+}
+
 func ExampleTryUnwrap() {
 	result1 := TryUnwrap(strconv.Atoi("42"))
 	fmt.Println(result1)