package task

Import Path
	go.pact.im/x/task (on go.dev)

Dependency Relation
	imports 4 packages, and imported by one package

Involved Source Files

	      cond.go
	      context.go
	      executor.go
	   #d task.go
		Package task provides an alternative to errgroup package with builtin context
		cancellation support.

		This packages uses go.uber.org/multierr to combine errors from failed tasks.
Package-Level Type Names (total 4, in which 3 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type CancelCondition (func)
		CancelCondition is a condition for canceling the task group.

		As Outputs Of (at least 3, all are exported)
			func CancelOnError() CancelCondition
			func CancelOnReturn() CancelCondition
			func NeverCancel() CancelCondition
		As Inputs Of (at least 3, all are exported)
			func Parallel(cond CancelCondition, tasks ...Task) Task
			func Sequential(cond CancelCondition, tasks ...Task) Task
			func Executor.Execute(ctx context.Context, cond CancelCondition, tasks ...Task) error

	 type Executor (interface)
		Executor abstracts the execution order for task groups.

		Methods (only one, which is exported)
			( Executor) Execute(ctx context.Context, cond CancelCondition, tasks ...Task) error
		Implemented By (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			*executor
		As Outputs Of (at least 2, both are exported)
			func ParallelExecutor() Executor
			func SequentialExecutor() Executor

	 type Task (func)
		Task is a function that performs some work in foreground.

		Methods (only one, which is exported)
			( Task) Run(ctx context.Context) error
				Run executes the task.

		As Outputs Of (at least 4, all are exported)
			func Contextify(task func() error, shutdown func()) Task
			func Named(name string, run Task) Task
			func Parallel(cond CancelCondition, tasks ...Task) Task
			func Sequential(cond CancelCondition, tasks ...Task) Task
		As Inputs Of (at least 4, all are exported)
			func Named(name string, run Task) Task
			func Parallel(cond CancelCondition, tasks ...Task) Task
			func Sequential(cond CancelCondition, tasks ...Task) Task
			func Executor.Execute(ctx context.Context, cond CancelCondition, tasks ...Task) error

	/* one unexported ... *//* one unexported: */
	 type executor (struct)
		executor implements the Executor interface using the underlying task group
		builder.

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			group func(cond CancelCondition, tasks ...Task) Task
		Methods (only one, which is exported)
			(*executor) Execute(ctx context.Context, cond CancelCondition, tasks ...Task) error
				Execute implements the Executor interface.

		Implements (at least one exported)
			*executor : Executor
		As Types Of (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			  var parallelExecutor
			  var sequentialExecutor


Package-Level Functions (total 12, in which 9 are exported)

	 func CancelOnError() CancelCondition
		CancelOnError indicates that task group should return on non-nil error. This
		is the same behavior as the golang.org/x/sync/errgroup package.

	 func CancelOnReturn() CancelCondition
		CancelOnReturn indicates that task group should be canceled if any
		subtask returns.

	 func Contextify(task func() error, shutdown func()) Task
		Contextify adds context cancellation support to the task using the given
		shutdown function.

	 func Named(name string, run Task) Task
		Named returns a task that returns an error prefixed with name on failure.

	 func NeverCancel() CancelCondition
		NeverCancel indicates that task group should not be canceled until
		all subtasks complete.

	 func Parallel(cond CancelCondition, tasks ...Task) Task
		Parallel returns a function that executes a group of tasks in parallel using
		the given cancellation condition. The resulting Task returns combined errors
		for all failed subtasks.

	 func ParallelExecutor() Executor
		ParallelExecutor returns an Executor instance for parallel execution.

	 func Sequential(cond CancelCondition, tasks ...Task) Task
		Sequential returns a function that executes a group of tasks sequentially
		using the given cancellation condition. The resulting Task returns combined
		errors for all failed subtasks.

	 func SequentialExecutor() Executor
		SequentialExecutor returns an Executor instance for sequential execution.

	/* 3 unexporteds ... *//* 3 unexporteds: */
	 func cancelOnError(err error) (cancel bool)
	 func cancelOnReturn(err error) (cancel bool)
	 func neverCancel(err error) (cancel bool)
Package-Level Variables (total 2, neither is exported)

	/* 2 unexporteds ... *//* 2 unexporteds: */
	  var parallelExecutor executor
	  var sequentialExecutor executor

The pages are generated with Golds v0.4.9. (GOOS=linux GOARCH=amd64)