syncutil

Documentation

Index

• type Future
  • func NewFuture[T any]() (f *Future[T], complete func(T))
  • func (f *Future[T]) Done() <-chan struct{}
  • func (f *Future[T]) Get() T

Types

type Future

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

A Future holds a value that might not be available yet.

func NewFuture

func NewFuture[T any]() (f *Future[T], complete func(T))

NewFuture returns a new future and a function that completes that future with the given value. The returned complete function becomes a no-op after the first usage.

func (*Future[T]) Done

func (f *Future[T]) Done() <-chan struct{}

Done returns a channel that is closed when the future completes.

func (*Future[T]) Get

func (f *Future[T]) Get() T

Get blocks, if necessary, until the future is completed and then returns its value.