usererr

Documentation

Index

• func HasUserMessage(err error) bool
• func IsWarning(err error) bool
• func New(msg string, args ...any) error
• func NewExecError(source error) error
• func NewWarning(msg string, args ...any) error
• func ShouldLogError(err error) bool
• func WithLoggedUserMessage(source error, msg string, args ...any) error
• func WithUserMessage(source error, msg string, args ...any) error
• type ExitError
  • func (e *ExitError) Error() string
  • func (e *ExitError) ExitCode() int
  • func (e *ExitError) Is(target error) bool
  • func (e *ExitError) Unwrap() error

Functions

func HasUserMessage

func HasUserMessage(err error) bool

func IsWarning

func IsWarning(err error) bool

func New

func New(msg string, args ...any) error

New creates new user error with the given message. By default these errors are not logged to Sentry. If you want to log the error, use NewLogged

func NewExecError

func NewExecError(source error) error

func NewWarning

func NewWarning(msg string, args ...any) error

func ShouldLogError

func ShouldLogError(err error) bool

ShouldLogError returns true if the it's a logged user error or is a non-user error

func WithLoggedUserMessage

func WithLoggedUserMessage(source error, msg string, args ...any) error

func WithUserMessage

func WithUserMessage(source error, msg string, args ...any) error

Types

type ExitError

type ExitError struct {
	// contains filtered or unexported fields
}

ExitError is an ExitError for a command run on behalf of a user

func (*ExitError) Error

func (e *ExitError) Error() string

func (*ExitError) ExitCode

func (e *ExitError) ExitCode() int

func (*ExitError) Is

func (e *ExitError) Is(target error) bool

func (*ExitError) Unwrap

func (e *ExitError) Unwrap() error

Unwrap provides compatibility for Go 1.13 error chains.