errgroup

Imports

Imports #

"context"
"context"
"context"
"fmt"
"sync"

Structs

Group struct #

A Group is a collection of goroutines working on subtasks that are part of the same overall task. A zero Group is valid, has no limit on the number of active goroutines, and does not cancel on error.

type Group struct {
cancel func(error)
wg sync.WaitGroup
sem chan token
errOnce sync.Once
err error
}

token struct #

type token struct {

}

Functions

Go method #

Go calls the given function in a new goroutine. It blocks until the new goroutine can be added without the number of active goroutines in the group exceeding the configured limit. The first call to return a non-nil error cancels the group's context, if the group was created by calling WithContext. The error will be returned by Wait.

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

SetLimit method #

SetLimit limits the number of active goroutines in this group to at most n. A negative value indicates no limit. Any subsequent call to the Go method will block until it can add an active goroutine without exceeding the configured limit. The limit must not be modified while any goroutines in the group are active.

func (g *Group) SetLimit(n int)

TryGo method #

TryGo calls the given function in a new goroutine only if the number of active goroutines in the group is currently below the configured limit. The return value reports whether the goroutine was started.

func (g *Group) TryGo(f func() error) bool

Wait method #

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

func (g *Group) Wait() error

WithContext function #

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 WithContext(ctx context.Context) (*Group, context.Context)

done method #

func (g *Group) done()

withCancelCause function #

func withCancelCause(parent context.Context) (context.Context, func(error))

withCancelCause function #

func withCancelCause(parent context.Context) (context.Context, func(error))

Generated with Arrow