package errgroup

Import Path
	golang.org/x/sync/errgroup (on go.dev)

Dependency Relation
	imports 3 packages, and imported by one package

Involved Source Files

	  d errgroup.go
		Package errgroup provides synchronization, error propagation, and Context
		cancelation for groups of goroutines working on subtasks of a common task.
		
		[errgroup.Group] is related to [sync.WaitGroup] but adds handling of tasks
		returning errors.
Package-Level Type Names (total 2, in which 1 is exported)

	/* sort exporteds by: alphabet | popularity */
	 type Group (struct)
		A Group is a collection of goroutines working on subtasks that are part of
		the same overall task. A Group should not be reused for different tasks.
		
		A zero Group is valid, has no limit on the number of active goroutines,
		and does not cancel on error.

		Fields (total 5, none are exported)
			/* 5 unexporteds ... *//* 5 unexporteds: */
			cancel func(error)
			err error
			errOnce sync.Once
			sem chan token
			wg sync.WaitGroup
		Methods (total 5, in which 4 are exported)
			(*Group) Go(f func() error)
				Go calls the given function in a new goroutine.
				
				The first call to Go must happen before a Wait.
				It blocks until the new goroutine can be added without the number of
				goroutines in the group exceeding the configured limit.
				
				The first goroutine in the group that returns a non-nil error will
				cancel the associated Context, if any. The error will be returned
				by Wait.

			(*Group) SetLimit(n int)
				SetLimit limits the number of active goroutines in this group to at most n.
				A negative value indicates no limit.
				A limit of zero will prevent any new goroutines from being added.
				
				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.

			(*Group) TryGo(f func() error) bool
				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.

			(*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.

			/* one unexported ... *//* one unexported: */
			(*Group) done()
		As Outputs Of (at least one exported)
			func WithContext(ctx context.Context) (*Group, context.Context)

	/* one unexported ... *//* one unexported: */
	 type token (struct)
Package-Level Functions (only one, which is exported)

	 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.

The pages are generated with Golds v0.7.6. (GOOS=linux GOARCH=amd64)