errgroup

README

errgroup

Provides a panic handling wrapper around golang.org/x/sync/errgroup to avoid application crashes when a goroutine encounters a panic. In the event of a panic this wrapper will convert the panic into an error that is returned from the Wait function. In all other ways this wrapper behaves exactly as the wrapped Group.

Documentation

Overview

Package errgroup provides a panic handling wrapper around golang.org/x/sync/errgroup to avoid application crashes when a goroutine encounters a panic.

In the event of a panic this wrapper will convert the panic into an error that is returned from the Wait function. In all other ways this wrapper behaves exactly as the wrapped Group.

Index

• type Group
  • func New(opts ...Opt) Group
  • func NewContext(ctx context.Context, opts ...Opt) (Group, context.Context)
• type Opt
  • func WithPanicHandler(ph PanicHandler) Opt
• type PanicHandler

Types

type Group

type Group interface {
	Go(f func() error)
	Wait() error
}

Group provides an interface compatible with golang.org/x/sync/errgroup for instances that enhance the capabilities of Groups.

func New

func New(opts ...Opt) Group

New creates a panic-handling Group, without any context cancellation.

func NewContext

func NewContext(ctx context.Context, opts ...Opt) (Group, context.Context)

NewContext creates a panic-handling Group. The returned context is cancelled on first error, first panic, or when the Wait function exits.

type Opt

type Opt func(g *panicGroup)

Opt is a configuration option.

func WithPanicHandler

func WithPanicHandler(ph PanicHandler) Opt

WithPanicHandler overrides the default panic handler.

type PanicHandler

type PanicHandler func(p any) error

PanicHandler processes the recovered panic.