serrgroup

Documentation

Overview

Package serrgroup is an error group that does not crash if work is added after Wait has returned after an error. In addition, the error is exposed via the API. This is based on https://cs.opensource.google/go/x/sync/+/036812b2:errgroup/errgroup.go with some modifications.

Index

• type Group
  • func WithContext(ctx context.Context) (*Group, context.Context)
  • func (g *Group) Err() error
  • func (g *Group) Go(f func() error)
  • func (g *Group) Wait() error

Types

type Group

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

A Group is a collection of goroutines working on subtasks that are part of the same overall task.

A zero Group is valid and does not cancel on error.

func WithContext

func WithContext(ctx context.Context) (*Group, context.Context)

WithContext returns a new Group and an associated Context derived from ctx.

The derived Context is canceled the first time a function passed to Go returns a non-nil error or the first time Wait returns, whichever occurs first.

func (*Group) Err

func (g *Group) Err() error

Err returns the first non-nil error (if any) of all goroutines started by Go.

func (*Group) Go

func (g *Group) Go(f func() error)

Go calls the given function in a new goroutine.

The first call to return a non-nil error cancels the group; its error will be returned by Wait.

func (*Group) Wait

func (g *Group) Wait() error

Wait blocks until all function calls from the Go method have returned, then returns the first non-nil error (if any) from them.