errint

Documentation

Overview

Package errint provides additional context for error messages that are the result of a programming error.

Index

• Variables
• func New(s string) error
• func Newf(s string, vs ...interface{}) error
• func Wrap(e error) error
• type Internal
  • func (i *Internal) Error() string
  • func (i *Internal) Unwrap() error

Variables

var SkipContext = false

SkipContext may be set to true during development to elide rigmarole.

Functions

func New

func New(s string) error

New creates an internal error from a string.

func Newf

func Newf(s string, vs ...interface{}) error

Newf creates an internal error from fmt.Errorf.

func Wrap

func Wrap(e error) error

Wrap wraps an error, flagging it as an internal error.

Types

type Internal

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

Internal represents an error resulting from bad programming. It includes context of what to do if such an error is encountered.

func (*Internal) Error

func (i *Internal) Error() string

func (*Internal) Unwrap

func (i *Internal) Unwrap() error

Unwrap returns the wrapped error.