mirror of
https://github.com/yusing/godoxy.git
synced 2025-05-20 12:42:34 +02:00
80bc018a7f
* chore: replace gopkg.in/yaml.v3 vs goccy/go-yaml; replace encoding/json with bytedance/sonic * fix: yaml unmarshal panic * feat: custom json marshaler implementation * chore: fix import and err marshal handling --------- Co-authored-by: yusing <yusing@6uo.me> |
||
|---|---|---|
| .. | ||
| base.go | ||
| builder.go | ||
| builder_test.go | ||
| error.go | ||
| error_test.go | ||
| log.go | ||
| multiline.go | ||
| multiline_test.go | ||
| nested_error.go | ||
| README.md | ||
| subject.go | ||
| utils.go | ||
| utils_test.go | ||
gperr
gperr is an error interface that supports nested structure and subject highlighting.
Usage
gperr.Error
The error interface.
gperr.New
Like errors.New, but returns a gperr.Error.
gperr.Wrap
Like fmt.Errorf("%s: %w", message, err), but returns a gperr.Error.
gperr.Error.Subject
Returns a new error with the subject prepended to the error message. The main subject is highlighted.
err := gperr.New("error message")
err = err.Subject("bar")
err = err.Subject("foo")
Output:
foo > bar: error message
gperr.Error.Subjectf
Like gperr.Error.Subject, but formats the subject with fmt.Sprintf.
gperr.PrependSubject
Prepends the subject to the error message like gperr.Error.Subject.
err := gperr.New("error message")
err = gperr.PrependSubject(err, "foo")
err = gperr.PrependSubject(err, "bar")
Output:
bar > foo: error message
gperr.Error.With
Adds a new error to the error chain.
err := gperr.New("error message")
err = err.With(gperr.New("inner error"))
err = err.With(gperr.New("inner error 2").With(gperr.New("inner inner error")))
Output:
error message:
• inner error
• inner error 2
• inner inner error
gperr.Error.Withf
Like gperr.Error.With, but formats the error with fmt.Errorf.
gperr.Error.Is
Returns true if the error is equal to the given error.
gperr.Builder
A builder for gperr.Error.
builder := gperr.NewBuilder("foo")
builder.Add(gperr.New("error message"))
builder.Addf("error message: %s", "foo")
builder.AddRange(gperr.New("error message 1"), gperr.New("error message 2"))
Output:
foo:
• error message
• error message: foo
• error message 1
• error message 2
gperr.Builder.Build
Builds a gperr.Error from the builder.
When to return gperr.Error
- When you want to return multiple errors
- When the error has a subject