vizerror

Documentation

Overview

Package vizerror provides types and utility funcs for handling visible errors that are safe to display to end users.

Index

• func Errorf(format string, a ...any) error
• func New(text string) error
• func Wrap(err error) error
• type Error
  • func As(err error) (e Error, ok bool)
  • func (e Error) Error() string
  • func (e Error) Unwrap() error

Functions

func Errorf

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

Errorf returns an Error with the specified format and values. It always returns a vizerror.Error.

func New

func New(text string) error

New returns an error that formats as the given text. It always returns a vizerror.Error.

func Wrap

func Wrap(err error) error

Wrap wraps err with a vizerror.Error.

Types

type Error

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

Error is an error that is safe to display to end users.

func As

func As(err error) (e Error, ok bool)

As returns the first vizerror.Error in err's chain.

func (Error) Error

func (e Error) Error() string

Error implements the error interface.

func (Error) Unwrap

func (e Error) Unwrap() error

Unwrap returns the underlying error.