errortrace

Documentation

Overview

Package errortrace provides a method to track function stacktrace and populate it in case of error.

Index

• func IgnoreFunc(fn interface{}) string
• func IgnorePackage(fn interface{}) string
• func IgnoreStruct(fn interface{}) string
• type Call
• type ErrorTrace
  • func (et *ErrorTrace) Error() string
  • func (et *ErrorTrace) ErrorText() string
  • func (et *ErrorTrace) Is(err error) bool
  • func (et *ErrorTrace) SetContext(ctx string)
  • func (et *ErrorTrace) SetDescription(description string)
  • func (et *ErrorTrace) SetError(err error)
  • func (et *ErrorTrace) Unwrap() error
• type Template
  • func New(ignore ...string) *Template
  • func (t *Template) Error(description string, err error, ctx string) error
  • func (t *Template) Prepare() *ErrorTrace

Functions

func IgnoreFunc

func IgnoreFunc(fn interface{}) string

IgnoreFunc can be used to ignore the specified function in a package for the trace.

func IgnorePackage

func IgnorePackage(fn interface{}) string

IgnorePackage can be used to ignore all functions in a package for the trace.

func IgnoreStruct

func IgnoreStruct(fn interface{}) string

IgnoreStruct can be used to ignore all struct functions in the trace.

Types

type Call

type Call struct {
	PackageName  string
	FunctionPath string
	FunctionName string
	File         string
	Line         int
	PC           uintptr
	Entry        uintptr
	FullName     string
}

Call represents a call on the stack.

type ErrorTrace

type ErrorTrace struct {
	// contains filtered or unexported fields
}

ErrorTrace represents an ErrorTrace, it includes the parent trace (if called with Prepare).

func (*ErrorTrace) Error

func (et *ErrorTrace) Error() string

Error returns the string representation for the error. It includes the Stacktrace, Description and Context.

func (*ErrorTrace) ErrorText

func (et *ErrorTrace) ErrorText() string

ErrorText returns only the error text for the error.

func (*ErrorTrace) Is

func (et *ErrorTrace) Is(err error) bool

Is implements the xerrors interface so we can use the xerrors.Is() function.

func (*ErrorTrace) SetContext

func (et *ErrorTrace) SetContext(ctx string)

SetContext sets the context information that should be printed for this error.

func (*ErrorTrace) SetDescription

func (et *ErrorTrace) SetDescription(description string)

SetDescription sets the description that should be printed for this error.

func (*ErrorTrace) SetError

func (et *ErrorTrace) SetError(err error)

SetError sets the error.

func (*ErrorTrace) Unwrap

func (et *ErrorTrace) Unwrap() error

Unwrap implements the xerrors.Wrapper interface.

type Template

type Template struct {
	// contains filtered or unexported fields
}

Template is used as a factory to create a new ErrorTrace when you need it, use New() to create an Template.

func New

func New(ignore ...string) *Template

New can be used to create an Template with the desired parameters.

func (*Template) Error

func (t *Template) Error(description string, err error, ctx string) error

Error generates an ErrorTrace on the current position.

func (*Template) Prepare

func (t *Template) Prepare() *ErrorTrace

Prepare collects the current trace, if later a Panic will be called the collected trace will be included in the error trace.