Source File
	value.go

Belonging Package
	github.com/alitto/pond/v2/internal/future

package future

import (
	"context"
	"fmt"
)

type ValueFutureResolver[V any] func(value V, err error)

// 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.
type ValueFuture[V any] struct {
	ctx context.Context
}

func (f *ValueFuture[V]) Done() <-chan struct{} {
	return f.ctx.Done()
}

func (f *ValueFuture[V]) Result() (V, error) {
	<-f.ctx.Done()

	cause := context.Cause(f.ctx)
	if cause != nil {
		if resolution, ok := cause.(*valueFutureResolution[V]); ok {
			return resolution.value, resolution.err
		}
	}
	var zero V
	return zero, cause
}

// Get waits for the future to complete and returns the output and any error that occurred.
func (f *ValueFuture[V]) Wait() (V, error) {
	return f.Result()
}

func NewValueFuture[V any](ctx context.Context) (*ValueFuture[V], ValueFutureResolver[V]) {
	childCtx, cancel := context.WithCancelCause(ctx)
	future := &ValueFuture[V]{
		ctx: childCtx,
	}
	return future, func(value V, err error) {
		cancel(&valueFutureResolution[V]{
			value: value,
			err:   err,
		})
	}
}

type valueFutureResolution[V any] struct {
	value V
	err   error
}

func (v *valueFutureResolution[V]) Error() string {
	if v.err != nil {
		return v.err.Error()
	}
	return fmt.Sprintf("future resolved: %#v", v.value)
}

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.