package synctest

Import Path
	internal/synctest (on go.dev)

Dependency Relation
	imports 2 packages, and imported by 2 packages

Involved Source Files

	  d synctest.go
		Package synctest provides support for testing concurrent code.
		
		See the testing/synctest package for function documentation.
Package-Level Type Names (total 2)

	/* sort by: alphabet | popularity */
	 type Association int (basic type)
		Association is the state of a pointer's bubble association.

		As Outputs Of (at least one exported)
			func Associate[T](p *T) Association
		As Types Of (total 3)
			const CurrentBubble
			const OtherBubble
			const Unbubbled

	 type Bubble (struct)
		A Bubble is a synctest bubble.
		
		Not a public API. Used by syscall/js to propagate bubble membership through syscalls.

		Methods (total 2)
			(*Bubble) Release()
				Release releases the reference to the bubble,
				allowing it to become idle again.

			(*Bubble) Run(f func())
				Run executes f in the bubble.
				The current goroutine must not be part of a bubble.

		As Outputs Of (at least one exported)
			func Acquire() *Bubble


Package-Level Functions (total 7)

	 func Acquire() *Bubble
		Acquire returns a reference to the current goroutine's bubble.
		The bubble will not become idle until Release is called.

	 func Associate[T](p *T) Association

		Type Parameters:
			T: any

		Associate attempts to associate p with the current bubble.
		It returns the new association status of p.

	 func Disassociate[T](p *T)

		Type Parameters:
			T: any

		Disassociate disassociates p from any bubble.

	 func IsAssociated[T](p *T) bool

		Type Parameters:
			T: any

		IsAssociated reports whether p is associated with the current bubble.

	 func IsInBubble() bool
		IsInBubble reports whether the current goroutine is in a bubble.

	 func Run(f func())
	 func Wait()
Package-Level Constants (total 3)

	const CurrentBubble Association = 1 // associated with the current bubble
	const OtherBubble Association = 2 // associated with a different bubble
	const Unbubbled Association = 0 // not associated with any bubble

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.