errors

README

errors

errors + stack staces.

Key features of k1LoW/errors are:

• Retain the stack traces once stacked as far as possible.
  • Support for errors.Join.
• It is possible to output stack traces in structured data.
• It is possible to separate joined errors.
• Zero dependency

Usage

import (
    // "errors"
    "github.com/k1LoW/errors"
)

Example

https://go.dev/play/p/8zQvFThxI4O

Difference between errors and k1LoW/errors

• The behaviour of methods with the same name as the errors package is the same.
• k1LoW/errors has WithStack, StackTraces and Errors functions.

References

• go-errors/errors
• cockroachdb/errors

Documentation

Index

• Variables
• func As(err error, target any) bool
• func Errors(err error) []error
• func Is(err, target error) bool
• func Join(errs ...error) error
• func New(text string) error
• func StackTraces(err error) stackTraces
• func Unwrap(err error) error
• func WithStack(err error) error
• type Frame

Variables

var MaxStackDepth = 50

MaxStackDepth is the maximum depth of the stack trace.

Functions

func As

func As(err error, target any) bool

As is a wrapper for errors.As.

func Errors

func Errors(err error) []error

Errors returns all joined errors in the given error.

func Is

func Is(err, target error) bool

Is is a wrapper for errors.Is.

func Join

func Join(errs ...error) error

Join is a wrapper for errors.Join.

func New

func New(text string) error

New is a wrapper for errors.New.

func StackTraces

func StackTraces(err error) stackTraces

StackTraces returns the stack traces of the given error(s).

func Unwrap

func Unwrap(err error) error

Unwrap is a wrapper for errors.Unwrap.

func WithStack

func WithStack(err error) error

WithStack sets the stack trace for the given error.

Types

type Frame

type Frame struct {
	Name string `json:"name"`
	File string `json:"file"`
	Line int    `json:"line"`
}