errgroup

package
v0.0.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 8, 2023 License: MIT Imports: 4 Imported by: 0

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewOptions

func NewOptions() *options

NewOptions new options struct

func PrintOptions

func PrintOptions(packageName string)

Types

type Group

type Group struct {
	// contains filtered or unexported fields
}
Example (JustErrors)

JustErrors illustrates the use of a Group in place of a sync.WaitGroup to simplify goroutine counting and error handling. This example is derived from the sync.WaitGroup example at https://golang.org/pkg/sync/#example_WaitGroup.

g := New()
var urls = []string{
	"http://www.golang.org/",
	"http://www.google.com/",
	"http://www.somestupidname.com/",
}
for _, url := range urls {
	// Launch a goroutine to fetch the URL.
	url := url // https://golang.org/doc/faq#closures_and_goroutines
	g.Go(func() error {
		// Fetch the URL.
		resp, err := http.Get(url)
		if err == nil {
			resp.Body.Close()
		}
		return err
	})
}
// Wait for all HTTP fetches to complete.
if err := g.Wait(); err == nil {
	fmt.Println("Successfully fetched all URLs.")
}
Output:

Example (Parallel)

Parallel illustrates the use of a Group for synchronizing a simple parallel task: the "Google Search 2.0" function from https://talks.golang.org/2012/concurrency.slide#46, augmented with a Context and error-handling.

Google := func(ctx context.Context, query string) ([]Result, error) {
	g, ctx := WithContext(ctx)

	searches := []Search{Web, Image, Video}
	results := make([]Result, len(searches))
	for i, search := range searches {
		i, search := i, search // https://golang.org/doc/faq#closures_and_goroutines
		g.Go(func() error {
			result, err := search(ctx, query)
			if err == nil {
				results[i] = result
			}
			return err
		})
	}
	if err := g.Wait(); err != nil {
		return nil, err
	}
	return results, nil
}

results, err := Google(context.Background(), "golang")
if err != nil {
	fmt.Fprintln(os.Stderr, err)
	return
}
for _, result := range results {
	fmt.Println(result)
}
Output:

web result for "golang"
image result for "golang"
video result for "golang"

func New

func New(_opts ...Option) *Group

New constructor

func WithContext

func WithContext(ctx context.Context, opts ...Option) (*Group, context.Context)

func (*Group) Go

func (g *Group) Go(f func() error)

func (*Group) GoCtx

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

func (*Group) SetLimit

func (g *Group) SetLimit(n int)

func (*Group) SetOptions

func (_g *Group) SetOptions(_opts ...Option) *Group

func (*Group) TryCtxGo

func (g *Group) TryCtxGo(ctx context.Context, f func(ctx context.Context) error) bool

func (*Group) TryGo

func (g *Group) TryGo(f func() error) bool

func (*Group) Wait

func (g *Group) Wait() error

type Option

type Option interface {
	// contains filtered or unexported methods
}

Option option interface

func SkipOption

func SkipOption() Option

func WithOptions

func WithOptions(o *options) Option

func WithPanicHandler

func WithPanicHandler(panicHandler ho.PanicHandler) Option

WithPanicHandler panicHandler option of Group

Jump to

Keyboard shortcuts

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