ctxgroup

Documentation

Index

• type Group
  • func New(ctx context.Context) *Group
  • func (g *Group) Go(fn func(ctx context.Context) error)
  • func (g *Group) Wait() error

Types

type Group

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

Group is similar to errgroup.Group. The main difference is Group.Go accepts a function with a context.Context as its first argument.

It's zero value is valid, it contains context.Background as its internal context and does not cancel on error.

func New

func New(ctx context.Context) *Group

New returns a new Group with ctx as its internal context, which is passed to the function(s) passed to Group.Go. The context is not canceled when a function passed to Group.Go returns an error.

func (*Group) Go

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

Go calls the given function in a new goroutine. The Group's internal context is passed as argument to the function. Errors from all calls are collected, combined and returned by Group.Wait.

func (*Group) Wait

func (g *Group) Wait() error

Wait blocks until all function calls from the Group.Go method have returned, then returns all collected errors as a (multi) error.