Skip to content

Commit

Permalink
feat: add join
Browse files Browse the repository at this point in the history
  • Loading branch information
sashamelentyev committed Aug 11, 2023
1 parent 9620480 commit 58d813f
Show file tree
Hide file tree
Showing 4 changed files with 102 additions and 1 deletion.
2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
module github.com/go-faster/errors

go 1.18
go 1.20
59 changes: 59 additions & 0 deletions join.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
//go:build !go1.20
// +build !go1.20

package errors

import "unsafe"

// Join returns an error that wraps the given errors.
// Any nil error values are discarded.
// Join returns nil if every value in errs is nil.
// 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.
//
// A non-nil error returned by Join implements the Unwrap() []error method.
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 {
// Since Join returns nil if every value in errs is nil,
// e.errs cannot be empty.
if len(e.errs) == 1 {
return e.errs[0].Error()
}

b := []byte(e.errs[0].Error())
for _, err := range e.errs[1:] {
b = append(b, '\n')
b = append(b, err.Error()...)
}
// At this point, b has at least one byte '\n'.
return unsafe.String(&b[0], len(b))
}

func (e *joinError) Unwrap() []error {
return e.errs
}
8 changes: 8 additions & 0 deletions join_go120.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
//go:build go1.20
// +build go1.20

package errors

import "errors"

var Join = errors.Join
34 changes: 34 additions & 0 deletions join_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
package errors_test

import (
"reflect"
"testing"

"github.com/go-faster/errors"
)

func TestJoin(t *testing.T) {
err1 := errors.New("err1")
err2 := errors.New("err2")
for _, test := range []struct {
errs []error
want []error
}{{
errs: []error{err1},
want: []error{err1},
}, {
errs: []error{err1, err2},
want: []error{err1, err2},
}, {
errs: []error{err1, nil, err2},
want: []error{err1, err2},
}} {
got := errors.Join(test.errs...).(interface{ Unwrap() []error }).Unwrap()
if !reflect.DeepEqual(got, test.want) {
t.Errorf("Join(%v) = %v; want %v", test.errs, got, test.want)
}
if len(got) != cap(got) {
t.Errorf("Join(%v) returns errors with len=%v, cap=%v; want len==cap", test.errs, len(got), cap(got))
}
}
}

0 comments on commit 58d813f

Please sign in to comment.