errgroup

package

v0.7.0 Latest Latest Go to latest Published: Jan 13, 2024 License: MIT Imports: 4 Imported by: 2

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/tomcz/gotools

Links

Open Source Insights

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

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

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 ¶ added in v0.3.0

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 ¶ added in v0.2.11

type Opt func(g *panicGroup)

Opt is a configuration option.

func WithPanicHandler ¶ added in v0.2.11

func WithPanicHandler(ph PanicHandler) Opt

WithPanicHandler overrides the default panic handler.

type PanicHandler ¶ added in v0.2.9

type PanicHandler func(p any) error

PanicHandler processes the recovered panic.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL