ctxgroup

README

ctxgroup

A wrapper around errgroup, making context usage more obvious. Instead of relying on shadowing errgroup's sub-context variables, it follows the "pass context.Context as the first argument of the function" idiom, which simplifies the context scoping through variable shadowing.

Example usage:

ctx := context.Background()
g := ctxgroup.WithContext(ctx)
g.GoCtx(func(ctx context.Context) error {
    // ctx gets cancelled when the other goroutine errors out or when Wait() returns
    <-ctx.Done()
    fmt.Println("first goroutine cancelled")
    return nil
})
g.GoCtx(func(ctx context.Context) error {
    return fmt.Errorf("second goroutine erroring out")
})
if err := g.Wait(); err != nil {
    fmt.Printf("ctxgroup.Wait returned: %v\n", err)
}

Documentation

Index

• type Group
  • func WithContext(ctx context.Context) Group
  • func (g Group) GoCtx(f func(ctx context.Context) error)
  • func (g Group) Wait() error

Types

type Group

type Group struct {
	*errgroup.Group
	// contains filtered or unexported fields
}

func WithContext

func WithContext(ctx context.Context) Group

func (Group) GoCtx

func (g Group) GoCtx(f func(ctx context.Context) error)

func (Group) Wait

func (g Group) Wait() error