README
¶
errors 
Highly opinionated Go errors package.
Install
go get github.com/neoxelox/errors
Usage
Check and run the example test file errors_test: go test -v.
See GoDev for further documentation.
Contribute
Feel free to contribute to this project : ) .
License
This project is licensed under the MIT License - read the LICENSE file for details.
Documentation
¶
Overview ¶
Package errors implements functions to deal with error handling.
Index ¶
- type Error
- func (self *Error) Cause(err error) *Error
- func (self Error) Error() string
- func (self *Error) Extra(extra map[string]any) *Error
- func (self Error) Format(format fmt.State, verb rune)
- func (self Error) Is(err error) bool
- func (self Error) MarshalJSON() ([]byte, error)
- func (self Error) MarshalText() ([]byte, error)
- func (self Error) Raise(args ...any) *Error
- func (self Error) Report(all ...bool) string
- func (self *Error) Skip(frames int) *Error
- func (self Error) String() string
- func (self *Error) With(message string, args ...any) *Error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Error ¶
type Error struct {
// contains filtered or unexported fields
}
Error represent an error with traceback.
func New ¶
New creates a new Error with a message (can have a format) and sets to optionally capture the stack trace when raised (default is true).
func (Error) Format ¶
Format implements the Formatter interface: - %s: Error message - %v: First error report - %+v: All errors reports - default: Error message
func (Error) MarshalJSON ¶
MarshalJSON implements the JSONMarshaler interface.
func (Error) MarshalText ¶
MarshalText implements the TextMarshaler interface.
func (Error) Raise ¶
Raise creates a new Error instance formatting its message if needed and optionally captures its stack trace.
func (Error) Report ¶
Report returns a string containing all the information about the first error (including the message, stack trace, extra...) or about all errors wrapped within the Error itself (default is all).
Source Files