package future

Import Path
	github.com/alitto/pond/v2/internal/future (on go.dev)

Dependency Relation
	imports 3 packages, and imported by one package

Involved Source Files

	    composite.go
	    future.go
	    value.go
Package-Level Type Names (total 6)

	/* sort by: alphabet | popularity */
	 type CompositeFuture[V] (struct)

		Type Parameters:
			V: any

		Methods (total 4)
			(*CompositeFuture[V]) Cancel(cause error)
			(*CompositeFuture[V]) Context() context.Context
			(*CompositeFuture[V]) Done(count int) <-chan struct{}
			(*CompositeFuture[V]) Wait(count int) ([]V, error)
		As Outputs Of (at least one exported)
			func NewCompositeFuture[V](ctx context.Context) (*CompositeFuture[V], CompositeFutureResolver[V])

	 type CompositeFutureResolver[V] (func)

		Type Parameters:
			V: any

		As Outputs Of (at least one exported)
			func NewCompositeFuture[V](ctx context.Context) (*CompositeFuture[V], CompositeFutureResolver[V])

	 type Future (struct)
		A Future represents a value that will be available in the Future.
		It is always associated with a context that can be used to wait for the value to be available.
		When the parent context is canceled, the Future will be canceled as well.

		Methods (total 3)
			(*Future) Done() <-chan struct{}
			(*Future) Err() error
			(*Future) Wait() error
				Wait waits for the future to complete and returns any error that occurred.

		Implements (at least one exported)
			*Future : github.com/alitto/pond/v2.Task
		As Outputs Of (at least one exported)
			func NewFuture(ctx context.Context) (*Future, FutureResolver)

	 type FutureResolver (func)

		As Outputs Of (at least one exported)
			func NewFuture(ctx context.Context) (*Future, FutureResolver)

	 type ValueFuture[V] (struct)

		Type Parameters:
			V: any

		A Future represents a value that will be available in the Future.
		It is always associated with a context that can be used to wait for the value to be available.
		When the parent context is canceled, the Future will be canceled as well.

		Methods (total 3)
			(*ValueFuture[V]) Done() <-chan struct{}
			(*ValueFuture[V]) Result() (V, error)
			(*ValueFuture[V]) Wait() (V, error)
				Get waits for the future to complete and returns the output and any error that occurred.

		As Outputs Of (at least one exported)
			func NewValueFuture[V](ctx context.Context) (*ValueFuture[V], ValueFutureResolver[V])

	 type ValueFutureResolver[V] (func)

		Type Parameters:
			V: any

		As Outputs Of (at least one exported)
			func NewValueFuture[V](ctx context.Context) (*ValueFuture[V], ValueFutureResolver[V])


Package-Level Functions (total 3)

	 func NewCompositeFuture[V](ctx context.Context) (*CompositeFuture[V], CompositeFutureResolver[V])

		Type Parameters:
			V: any

	 func NewFuture(ctx context.Context) (*Future, FutureResolver)
	 func NewValueFuture[V](ctx context.Context) (*ValueFuture[V], ValueFutureResolver[V])

		Type Parameters:
			V: any

The pages are generated with Golds v0.8.4. (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.