package helpers

Import Path
	/pkg/x/helpers (on go.dev)

Dependency Relation
	imports 8 packages, and imported by one package

Involved Source Files

	  d x_help.go
		Package helpers provides experimental and unstable helpers.
Package-Level Type Names (total 2)

	/* sort by: alphabet | popularity */
	 type FanFn (func)

		As Inputs Of (at least one exported)
			func FanOutIn(mach *am.Machine, name string, total, concurrency int, fn FanFn) (any, error)

	 type FanHandlers (struct)

		Fields (total 4)
			AnyState am.HandlerFinal
			Concurrency int
			GroupDone am.S
			GroupTasks am.S


Package-Level Functions (total 7)

	 func ErrFromCtxs(ctxs ...context.Context) error
		ErrFromCtxs returns the first non-nil error from a list of contexts.

	 func FanOutIn(mach *am.Machine, name string, total, concurrency int, fn FanFn) (any, error)
		FanOutIn creates [total] number of state pairs of "Name1" and "Name1Done", as
		well as init and merge states ("Name", "NameDone"). [name] is treated as a
		namespace and can't have other states within. Retry can be achieved by adding
		the init state repetively. FanOutIn can be chained, but it should be called
		before any mutations or telemetry (as it changes the state struct). The
		returned handlers struct can be used to adjust the concurrency level.

	 func NestedState(e *am.Event, strIDField string, machGetter func(id string) *am.Machine) (am.Result, <-chan struct{}, error)
		NestedState forwards the mutation to one of the composed submachines. Parent
		state should be a Multi state and only called directly (not from a relation).
		TODO test case, solve locking by passing the event to the submachine

	 func RaceCtx[T](ctx context.Context, ch chan T) (T, error)

		Type Parameters:
			T: *any

	 func RelationsMatrix(mach *am.Machine) ([][]int, error)
	 func TimeMatrix(machines []*am.Machine) ([]am.Time, error)
		TimeMatrix returns a matrix of state clocks for the given machines.

	 func TransitionMatrix(tx, prevTx *am.Transition, index am.S) ([][]int, error)

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.