package singleflight

Import Path
	internal/singleflight (on go.dev)

Dependency Relation
	imports one package, and imported by one package

Involved Source Files

	  d singleflight.go
		Package singleflight provides a duplicate function call suppression
		mechanism.
Package-Level Type Names (total 2)

	/* sort by: alphabet | popularity */
	 type Group (struct)
		Group represents a class of work and forms a namespace in
		which units of work can be executed with duplicate suppression.

		Methods (total 3)
			(*Group) Do(key string, fn func() (any, error)) (v any, err error, shared 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.

			(*Group) DoChan(key string, fn func() (any, error)) <-chan Result
				DoChan is like Do but returns a channel that will receive the
				results when they are ready.

			(*Group) ForgetUnshared(key string) bool
				ForgetUnshared tells the singleflight to forget about a key if it is not
				shared with any other goroutines. Future calls to Do for a forgotten key
				will call the function rather than waiting for an earlier call to complete.
				Returns whether the key was forgotten or unknown--that is, whether no
				other goroutines are waiting for the result.


	 type Result (struct)
		Result holds the results of Do, so they can be passed
		on a channel.

		Fields (total 3)
			Err error
			Shared bool
			Val any
		As Outputs Of (at least one exported)
			func (*Group).DoChan(key string, fn func() (any, error)) <-chan Result

The pages are generated with Golds v0.7.7-preview. (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.