multierr

package
v0.0.0-...-9d29f1b Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 4, 2023 License: BSD-3-Clause Imports: 3 Imported by: 0

Documentation

Overview

Package multierr provides a simple multiple-error type. It was inspired by github.com/go-multierror/multierror.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func New

func New(errs ...error) error

New returns an error composed from errs. Some errors in errs get special treatment:

  • nil errors are discarded
  • errors of type Error are expanded into the top level

If the resulting slice has length 0, New returns nil. If the resulting slice has length 1, New returns that error. If the resulting slice has length > 1, New returns that slice as an Error.

func Range

func Range(err error, fn func(error) bool) bool

Range performs a pre-order, depth-first iteration of the error tree by successively unwrapping all error values. For each iteration it calls fn with the current error value and stops iteration if it ever reports false.

Types

type Error

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

An Error represents multiple errors.

func (Error) As

func (e Error) As(target any) bool

As finds the first error in e that matches target, and if any is found, sets target to that error value and returns true. Otherwise, it returns false.

func (Error) Error

func (e Error) Error() string

Error implements the error interface.

func (Error) Errors

func (e Error) Errors() []error

Errors returns a slice containing all errors in e.

func (Error) Is

func (e Error) Is(target error) bool

Is reports whether any error in e matches target.

func (Error) Unwrap

func (e Error) Unwrap() []error

Unwrap returns the underlying errors as-is.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL