errors

Documentation

Overview

Package errors contains functionality for creating and wrapping errors with improved formatting compared to the standard Go error functionality.

Index

• func Errorf(format string, args ...any) error
• func New(message string) error
• func SetTopLevelMsg(err error, top string) error
• func SetTopLevelMsgf(err error, format string, args ...any) error
• func WithContext(err error, context string) error
• func WithContextf(err error, format string, args ...any) error
• func Wrap(err error, message string) error
• func Wrapf(err error, format string, args ...any) error

Functions

func Errorf

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

Errorf returns an error with a message formatted according to the format specifier.

func New

func New(message string) error

New returns an error with the given message.

func SetTopLevelMsg

func SetTopLevelMsg(err error, top string) error

SetTopLevelMsg returns a new error with the given top level message. The top level message is the first error message that gets printed when Error() is called on the returned error or any error wrapping it.

func SetTopLevelMsgf

func SetTopLevelMsgf(err error, format string, args ...any) error

SetTopLevelMsgf returns a new error with the given top level message according to the format specifier. The top level message is the first error message that gets printed when Error() is called on the returned error or any error wrapping it.

func WithContext

func WithContext(err error, context string) error

WithContext returns a new error adding additional context to err.

func WithContextf

func WithContextf(err error, format string, args ...any) error

WithContextf returns a new error adding additional context to err according to the format specifier.

func Wrap

func Wrap(err error, message string) error

Wrap returns a new error annotating err with a new message.

func Wrapf

func Wrapf(err error, format string, args ...any) error

Wrapf returns a new error annotating err with a new message according to the format specifier.