Documentation
¶
Index ¶
- type Group
- func (g *Group[K, V]) Do(key K, fn func() (V, error)) (v V, err error, shared bool)
- func (g *Group[K, V]) DoChan(key K, fn func() (V, error)) <-chan Result[V]
- func (g *Group[K, V]) DoContext(ctx context.Context, key K, fn func() (V, error)) (v V, err error, shared bool)
- func (g *Group[K, V]) Forget(key K)
- func (g *Group[K, V]) InFlight() int
- type Result
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Group ¶
type Group[K comparable, V any] struct { // contains filtered or unexported fields }
Group represents a class of work and forms a namespace in which units of work can be executed with duplicate suppression.
func (*Group[K, V]) Do ¶
Do executes and returns the results of the given function, making sure that only one execution is in-flight for a given key at a time. If a duplicate comes in, the duplicate caller waits for the original to complete and receives the same results. The return value shared indicates whether v was given to multiple callers.
func (*Group[K, V]) DoChan ¶
DoChan is like Do but returns a channel that will receive the results when they are ready.
The returned channel will not be closed.
func (*Group[K, V]) DoContext ¶
func (g *Group[K, V]) DoContext(ctx context.Context, key K, fn func() (V, error)) (v V, err error, shared bool)
DoContext is like Do but respects context cancellation. If the context is cancelled, it returns the context error immediately. The underlying function will still complete, but this caller won't wait for it.