errgroupx

Documentation

Index

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

Types

type Group

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

Group is a thin wrapper around golang.org/x/sync/errgroup.Group that helps not leak its context past the lifetime of the group. nolint: containedctx

func WithContext

func WithContext(ctx context.Context) Group

WithContext creates a Group as a child of the given context.

func (*Group) Cancel

func (g *Group) Cancel()

Cancel the group, without waiting for it to exit.

func (*Group) Close

func (g *Group) Close() error

Close the group by canceling it and waiting for it.

func (*Group) Context

func (g *Group) Context() context.Context

Context returns the context within this group.

func (*Group) Go

func (g *Group) Go(f func(ctx context.Context) error)

Go launch the given function in a goroutine as a member of the group. If the function returns an error, the Group-scoped context will be canceled.

func (*Group) Wait

func (g *Group) Wait() error

Wait for all child processes of the group to complete.