singleflight

Documentation

Index

• type Group
  • func (g *Group[A, B]) Do(key A, fn supplier[B]) (B, error, bool)
  • func (g *Group[A, B]) DoChan(key A, fn supplier[B]) <-chan ResultContainer[B]
  • func (g *Group[A, B]) Forget(key A)
• type ResultContainer

Types

type Group

type Group[A comparable, B 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[A, B]) Do

func (g *Group[A, B]) Do(
	key A,
	fn supplier[B],
) (B, error, bool)

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[A, B]) DoChan

func (g *Group[A, B]) DoChan(
	key A,
	fn supplier[B],
) <-chan ResultContainer[B]

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[A, B]) Forget

func (g *Group[A, B]) Forget(key A)

Forget tells the singleflight to forget about a key. Future calls to Do for this key will call the function rather than waiting for an earlier call to complete.

type ResultContainer

type ResultContainer[B any] struct {
	Err    error
	Shared bool
	// contains filtered or unexported fields
}

Result holds the results of Do so they can be passed on a channel.