errors

Documentation

Overview

Package errors provides structured error types for tcount.

Index

• Constants
• func Code(err error) string
• type Error
  • func IO(op string, err error) *Error
  • func New(message string) *Error
  • func NotFound(resource string) *Error
  • func Parse(message string, err error) *Error
  • func Validation(message string) *Error
  • func Wrap(err error, message string) *Error
  • func (e *Error) Error() string
  • func (e *Error) Unwrap() error
  • func (e *Error) WithCode(code string) *Error
  • func (e *Error) WithField(key string, value any) *Error
  • func (e *Error) WithHint(hint string) *Error

Constants

const (
	ErrCodeNotFound   = "NOT_FOUND"
	ErrCodeValidation = "VALIDATION"
	ErrCodeIO         = "IO"
	ErrCodeParse      = "PARSE"
	ErrCodeInternal   = "INTERNAL"
)

Error codes for categorization.

Functions

func Code

func Code(err error) string

Code extracts the error code from any error.

Types

type Error

type Error struct {
	Code    string
	Message string
	Op      string
	Err     error
	Fields  map[string]any
	Hint    string
}

Error is a structured error type with code, context, and chain support.

func IO

func IO(op string, err error) *Error

IO creates an IO error.

func New

func New(message string) *Error

New creates a new error with a message.

func NotFound

func NotFound(resource string) *Error

NotFound creates a NOT_FOUND error.

func Parse

func Parse(message string, err error) *Error

Parse creates a PARSE error.

func Validation

func Validation(message string) *Error

Validation creates a VALIDATION error.

func Wrap

func Wrap(err error, message string) *Error

Wrap wraps an existing error with a message.

func (*Error) Error

func (e *Error) Error() string

Error returns the error string with context.

func (*Error) Unwrap

func (e *Error) Unwrap() error

Unwrap returns the wrapped error.

func (*Error) WithCode

func (e *Error) WithCode(code string) *Error

WithCode sets the error code.

func (*Error) WithField

func (e *Error) WithField(key string, value any) *Error

WithField adds a context field.

func (*Error) WithHint

func (e *Error) WithHint(hint string) *Error

WithHint adds an actionable suggestion to the error.