Retracted: v1 was tagged by mistake from a breaking change while still on v0.

future

package

v1.8.0 Latest Latest Go to latest Published: Oct 26, 2026 License: Apache-2.0 Imports: 3 Imported by: 0

Details

Package future provides a value that one goroutine sets once and others wait for.

This section is empty.

This section is empty.

This section is empty.

type Future[T any] struct {
	// contains filtered or unexported fields
}

Future is a value that is set at most once. Once set it never changes, so waiters may keep using it without a lock.

func New[T any]() *Future[T]

New returns a Future that is not set yet.

func (f *Future[T]) Get() (value T, ready bool)

Get returns the value without waiting, or false if it is not set yet.

func (f *Future[T]) Set(value T) (stored bool)

Set stores value and wakes every waiter. It reports false, keeping the first value, if the Future is already set.

func (f *Future[T]) Wait(ctx context.Context) (T, error)

Wait blocks until the value is set or ctx is done.