agherr

Documentation

Overview

Package agherr contains AdGuard Home's error handling helpers.

Index

• func Annotate(msg string, errPtr *error, args ...interface{})
• func LogPanic(prefix string)
• func Many(message string, underlying ...error) (err error)
• type Error
  • func (err Error) Error() (msg string)

Functions

func Annotate

func Annotate(msg string, errPtr *error, args ...interface{})

Annotate annotates the error with the message, unless the error is nil. This is a helper function to simplify code like this:

func (f *foo) doStuff(s string) (err error) {
        defer func() {
                if err != nil {
                        err = fmt.Errorf("bad foo string %q: %w", s, err)
                }
        }()

        // …
}

Instead, write:

func (f *foo) doStuff(s string) (err error) {
        defer agherr.Annotate("bad foo string %q: %w", &err, s)

        // …
}

msg must contain the final ": %w" verb.

TODO(a.garipov): Clearify the function usage.

func LogPanic

func LogPanic(prefix string)

LogPanic is a convinient helper function to log a panic in a goroutine. It should not be used where proper error handling is required.

func Many

func Many(message string, underlying ...error) (err error)

Many wraps several errors and returns a single error.

TODO(a.garipov): Add formatting to message.

Types

type Error

type Error string

Error is the constant error type.

func (Error) Error

func (err Error) Error() (msg string)

Error implements the error interface for Error.