diff options
| author | Damien Neil <dneil@google.com> | 2022-09-22 10:43:26 -0700 |
|---|---|---|
| committer | Damien Neil <dneil@google.com> | 2022-09-29 18:40:40 +0000 |
| commit | 4a0a2b33dfa3c99250efa222439f2c27d6780e4a (patch) | |
| tree | 25b1d2541b1b1244fe86d3b7ab690bff475e7ac7 /src/errors/join.go | |
| parent | 36f046d934c66fb6eb47d568e04665708c096ad7 (diff) | |
| download | go-4a0a2b33dfa3c99250efa222439f2c27d6780e4a.tar.xz | |
errors, fmt: add support for wrapping multiple errors
An error which implements an "Unwrap() []error" method wraps all the
non-nil errors in the returned []error.
We replace the concept of the "error chain" inspected by errors.Is
and errors.As with the "error tree". Is and As perform a pre-order,
depth-first traversal of an error's tree. As returns the first
matching result, if any.
The new errors.Join function returns an error wrapping a list of errors.
The fmt.Errorf function now supports multiple instances of the %w verb.
For #53435.
Change-Id: Ib7402e70b68e28af8f201d2b66bd8e87ccfb5283
Reviewed-on: https://go-review.googlesource.com/c/go/+/432898
Reviewed-by: Cherry Mui <cherryyz@google.com>
Reviewed-by: Rob Pike <r@golang.org>
Run-TryBot: Damien Neil <dneil@google.com>
Reviewed-by: Joseph Tsai <joetsai@digital-static.net>
Diffstat (limited to 'src/errors/join.go')
| -rw-r--r-- | src/errors/join.go | 51 |
1 files changed, 51 insertions, 0 deletions
diff --git a/src/errors/join.go b/src/errors/join.go new file mode 100644 index 0000000000..dc5a716aa6 --- /dev/null +++ b/src/errors/join.go @@ -0,0 +1,51 @@ +// Copyright 2022 The Go Authors. All rights reserved. +// Use of this source code is governed by a BSD-style +// license that can be found in the LICENSE file. + +package errors + +// Join returns an error that wraps the given errors. +// Any nil error values are discarded. +// Join returns nil if errs contains no non-nil values. +// The error formats as the concatenation of the strings obtained +// by calling the Error method of each element of errs, with a newline +// between each string. +func Join(errs ...error) error { + n := 0 + for _, err := range errs { + if err != nil { + n++ + } + } + if n == 0 { + return nil + } + e := &joinError{ + errs: make([]error, 0, n), + } + for _, err := range errs { + if err != nil { + e.errs = append(e.errs, err) + } + } + return e +} + +type joinError struct { + errs []error +} + +func (e *joinError) Error() string { + var b []byte + for i, err := range e.errs { + if i > 0 { + b = append(b, '\n') + } + b = append(b, err.Error()...) + } + return string(b) +} + +func (e *joinError) Unwrap() []error { + return e.errs +} |
