errors

README

go-errors

Errors with stack traces.

Based on other packages that do the same. I use these in my personal projects, this package isn't intended to be used by others.

Documentation

Index

• Variables
• func AsType[E error](err error) (E, bool)
• func ErrorCodef(code StatusCode, format string, args ...any) error
• func ErrorMessage(code StatusCode, message string) error
• func ErrorMessagef(code StatusCode, message string, args ...any) error
• func ErrorPayload(code StatusCode, payload any) error
• func Errorf(format string, args ...any) error
• func FailJSON(w http.ResponseWriter, r *http.Request, err error)
• func HTTPCode(code StatusCode) int
• func HTTPCodeMessage(code StatusCode, message string) (int, string)
• func HasStack(err error) bool
• func HelperErrorf(format string, args ...any) error
• func Payload(err error) any
• func WithCode(code StatusCode, message string, cause error) error
• func WithCodeStack(code StatusCode, message string, cause error) error
• func WithStack(err error) error
• type StatusCode
  • func Code(err error) (StatusCode, string)
  • func Status(err error) StatusCode

Variables

var As = errors.As

var Is = errors.Is

var Join = errors.Join

var New = errors.New

var Unwrap = errors.Unwrap

Functions

func AsType

func AsType[E error](err error) (E, bool)

func ErrorCodef

func ErrorCodef(code StatusCode, format string, args ...any) error

Error with a code and internal message.

func ErrorMessage

func ErrorMessage(code StatusCode, message string) error

func ErrorMessagef

func ErrorMessagef(code StatusCode, message string, args ...any) error

Error with a publicly visible message.

func ErrorPayload

func ErrorPayload(code StatusCode, payload any) error

Error with a payload.

func Errorf

func Errorf(format string, args ...any) error

func FailJSON

func FailJSON(w http.ResponseWriter, r *http.Request, err error)

func HTTPCode

func HTTPCode(code StatusCode) int

func HTTPCodeMessage

func HTTPCodeMessage(code StatusCode, message string) (int, string)

func HasStack

func HasStack(err error) bool

func HelperErrorf

func HelperErrorf(format string, args ...any) error

func Payload

func Payload(err error) any

func WithCode

func WithCode(code StatusCode, message string, cause error) error

func WithCodeStack

func WithCodeStack(code StatusCode, message string, cause error) error

func WithStack

func WithStack(err error) error

Types

type StatusCode

type StatusCode int

const (
	StatusUnknown StatusCode = iota
	StatusCanceled
	StatusInvalidArgument
	StatusDeadlineExceeded
	StatusInternal
	StatusNotFound
	StatusUnauthenticated
	StatusPermissionDenied
	StatusAlreadyExists
	StatusFailedPrecondition
	StatusUnimplemented
)

Union of HTTP status codes & https://grpc.github.io/grpc/core/md_doc_statuscodes.html If you add a value here, search for all switches on this enum.

func Code

func Code(err error) (StatusCode, string)

func Status

func Status(err error) StatusCode