errfmt

Documentation

Index

• func FormatStderr(err error) string
• type Category
• type ClassifiedError
  • func Classify(err error) *ClassifiedError
  • func (c *ClassifiedError) Error() string
  • func (c *ClassifiedError) Unwrap() error

Functions

func FormatStderr

func FormatStderr(err error) string

FormatStderr returns a formatted error string for stderr output.

Types

type Category

type Category string

Category represents the type of error.

const (
	CategoryAuth        Category = "auth"
	CategoryPermission  Category = "permission"
	CategoryNotFound    Category = "not_found"
	CategoryTimeout     Category = "timeout"
	CategoryMissingAuth Category = "missing_auth"
	CategoryConflict    Category = "conflict"
	CategoryGeneric     Category = "generic"
)

type ClassifiedError

type ClassifiedError struct {
	Original error
	Category Category
	Hint     string
}

ClassifiedError holds a classified error with an actionable hint.

func Classify

func Classify(err error) *ClassifiedError

Classify auto-detects the error category and adds an actionable hint.

func (*ClassifiedError) Error

func (c *ClassifiedError) Error() string

func (*ClassifiedError) Unwrap

func (c *ClassifiedError) Unwrap() error