stackerr

README

Stackerr

Stackerr is a lightweight, un-opinionated Go package for errors with stack traces.

---

Installation

go get github.com/go-andiamo/stackerr

Documentation

Overview

Package stackerr - Go package for errors with stack trace

Index

• Variables
• func SetDefaultPackageFilter(pkg string)
• type FrameFormatter
• type PackageFilter
• type StackError
  • func New(msg string) StackError
  • func Newf(format string, args ...any) StackError
  • func Wrap(err error, msg string) StackError
• type StackInfo

Variables

var DefaultPackageName string

DefaultPackageName is the default (short) package name to be used to check which packages are to be captured for the errors stack info

var MaxStackDepth uint = 16

MaxStackDepth is the maximum stack depth to capture

Functions

func SetDefaultPackageFilter

func SetDefaultPackageFilter(pkg string)

SetDefaultPackageFilter sets the DefaultPackageFilter with a filter for the specified package

Types

type FrameFormatter

type FrameFormatter interface {
	StartLine() string
	FrameLine(frame runtime.Frame) string
}

var DefaultFrameFormatter FrameFormatter = &frameFormatter{}

DefaultFrameFormatter is the formatter used to format call stack frames when formatting StackError

If this is set to nil, no stack info is output when formatting StackError

type PackageFilter

type PackageFilter interface {
	Include(packageName string) bool
}

PackageFilter is the interface used by DefaultPackageFilter

var DefaultPackageFilter PackageFilter

DefaultPackageFilter is the default package filter used to determine which packages are to be captured for the errors stack info

type StackError

type StackError interface {
	error
	// WithCause returns a StackError with the cause set
	WithCause(cause error) StackError
	Unwrap() error
	Cause() error
	// StackInfo returns the call stack info for the error
	StackInfo() StackInfo
}

StackError is an error interface with stack info

func New

func New(msg string) StackError

New creates a new StackError with stack info

func Newf

func Newf(format string, args ...any) StackError

Newf creates a new StackError with stack info and a formatted message

func Wrap

func Wrap(err error, msg string) StackError

Wrap wraps an existing error with a StackError

Note: the stack info is based on the point at which Wrap is called (rather than the callers of the wrapped error)

type StackInfo

type StackInfo []runtime.Frame