errs

package

v0.2.5 Latest Latest Go to latest Published: Feb 16, 2026 License: MIT Imports: 1 Imported by: 0

Details

Package errs contains user-facing error wrappers and helpers.

This section is empty.

This section is empty.

func UserErrorf(format string, a ...any) error

UserErrorf is a user-facing error. This helper exists mostly to avoid linters complaining about errors starting with a capitalized letter.

type Error struct {
	Err    error
	Reason string
}

Error wraps an underlying error with a user-facing reason.

Reason is meant to be short and actionable; Err may contain technical details. When Err is nil, Error() falls back to Reason.

func Wrap(err error, reason string) Error

Wrap creates an Error with the given underlying error and user-facing reason.

func Wrapf(err error, format string, a ...any) Error

Wrapf creates an Error with the given underlying error and a formatted reason.

func (e Error) Error() string

func (e Error) ReasonText() string

ReasonText returns the user-facing reason for the error.

func (e Error) Unwrap() error