package goleak

Import Path
	go.uber.org/goleak (on go.dev)

Dependency Relation
	imports 7 packages, and imported by 0 packages

Involved Source Files

	   #d doc.go
		Package goleak is a Goroutine leak detector.

	      leaks.go
	      options.go
	      testmain.go
	      tracestack_new.go
Package-Level Type Names (total 6, in which 3 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Option (interface)
		Option lets users specify custom verifications.

		Methods (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			( Option) apply(*opts)
		Implemented By (at least 2, neither is exported)
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			 optionFunc
			*opts
		As Outputs Of (at least 5, in which 3 are exported)
			func Cleanup(cleanupFunc func(exitCode int)) Option
			func IgnoreCurrent() Option
			func IgnoreTopFunction(f string) Option
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			func addFilter(f func(stack.Stack) bool) Option
			func maxSleep(d time.Duration) Option
		As Inputs Of (at least 4, in which 3 are exported)
			func Find(options ...Option) error
			func VerifyNone(t TestingT, options ...Option)
			func VerifyTestMain(m TestingM, options ...Option)
			/* at least one unexported ... *//* at least one unexported: */
			func buildOpts(options ...Option) *opts

	 type TestingM (interface)
		TestingM is the minimal subset of testing.M that we use.

		Methods (only one, which is exported)
			( TestingM) Run() int
		Implemented By (at least one exported)
			*testing.M
		As Inputs Of (at least one exported)
			func VerifyTestMain(m TestingM, options ...Option)

	 type TestingT (interface)
		TestingT is the minimal subset of testing.TB that we use.

		Methods (only one, which is exported)
			( TestingT) Error(...interface{})
		Implemented By (at least 12, in which 8 are exported)
			*go.uber.org/zap.SugaredLogger
			 google.golang.org/grpc/grpclog.DepthLoggerV2 (interface)
			 google.golang.org/grpc/grpclog.LoggerV2 (interface)
			 google.golang.org/grpc/internal/grpclog.LoggerV2 (interface)
			*testing.B
			*testing.F
			*testing.T
			 testing.TB (interface)
			/* 4+ unexporteds ... *//* 4+ unexporteds: */
			*google.golang.org/grpc/grpclog.componentData
			*google.golang.org/grpc/grpclog.loggerT
			*google.golang.org/grpc/grpclog.loggerWrapper
			*testing.common
		As Inputs Of (at least one exported)
			func VerifyNone(t TestingT, options ...Option)

	/* 3 unexporteds ... *//* 3 unexporteds: */
	 type optionFunc (func)
		optionFunc lets us easily write options without a custom type.

		Methods (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			( optionFunc) apply(opts *opts)
		Implements (at least one exported)
			 optionFunc : Option

	 type opts (struct)

		Fields (total 4, none are exported)
			/* 4 unexporteds ... *//* 4 unexporteds: */
			cleanup func(int)
			filters []func(stack.Stack) bool
			maxRetries int
			maxSleep time.Duration
		Methods (total 3, none are exported)
			/* 3 unexporteds ... *//* 3 unexporteds: */
			(*opts) apply(opts *opts)
				implement apply so that opts struct itself can be used as
				an Option.

			(*opts) filter(s stack.Stack) bool
			(*opts) retry(i int) bool
		Implements (at least one exported)
			*opts : Option
		As Outputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func buildOpts(options ...Option) *opts
		As Inputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func filterStacks(stacks []stack.Stack, skipID int, opts *opts) []stack.Stack

	 type testHelper (interface)

		Methods (only one, which is exported)
			( testHelper) Helper()
		Implemented By (at least 10, in which 5 are exported)
			 github.com/golang/mock/gomock.TestHelper (interface)
			*testing.B
			*testing.F
			*testing.T
			 testing.TB (interface)
			/* 5+ unexporteds ... *//* 5+ unexporteds: */
			*github.com/golang/mock/gomock.cancelReporter
			 github.com/golang/mock/gomock.nopTestHelper
			 gotest.tools/v3/assert.helperT (interface)
			 gotest.tools/v3/internal/assert.helperT (interface)
			*testing.common
		Implements (at least 2, neither is exported)
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			 testHelper : gotest.tools/v3/assert.helperT
			 testHelper : gotest.tools/v3/internal/assert.helperT


Package-Level Functions (total 14, in which 6 are exported)

	 func Cleanup(cleanupFunc func(exitCode int)) Option
		Cleanup sets up a cleanup function that will be executed at the
		end of the leak check.
		When passed to [VerifyTestMain], the exit code passed to cleanupFunc
		will be set to the exit code of TestMain.
		When passed to [VerifyNone], the exit code will be set to 0.
		This cannot be passed to [Find].

	 func Find(options ...Option) error
		Find looks for extra goroutines, and returns a descriptive error if
		any are found.

	 func IgnoreCurrent() Option
		IgnoreCurrent records all current goroutines when the option is created, and ignores
		them in any future Find/Verify calls.

	 func IgnoreTopFunction(f string) Option
		IgnoreTopFunction ignores any goroutines where the specified function
		is at the top of the stack. The function name should be fully qualified,
		e.g., go.uber.org/goleak.IgnoreTopFunction

	 func VerifyNone(t TestingT, options ...Option)
		VerifyNone marks the given TestingT as failed if any extra goroutines are
		found by Find. This is a helper method to make it easier to integrate in
		tests by doing:

			defer VerifyNone(t)

	 func VerifyTestMain(m TestingM, options ...Option)
		VerifyTestMain can be used in a TestMain function for package tests to
		verify that there were no goroutine leaks.
		To use it, your TestMain function should look like:

			func TestMain(m *testing.M) {
			  goleak.VerifyTestMain(m)
			}

		See https://golang.org/pkg/testing/#hdr-Main for more details.

		This will run all tests as per normal, and if they were successful, look
		for any goroutine leaks and fail the tests if any leaks were found.

	/* 8 unexporteds ... *//* 8 unexporteds: */
	 func addFilter(f func(stack.Stack) bool) Option
	 func buildOpts(options ...Option) *opts
	 func filterStacks(stacks []stack.Stack, skipID int, opts *opts) []stack.Stack
		filterStacks will filter any stacks excluded by the given opts.
		filterStacks modifies the passed in stacks slice.

	 func isStdLibStack(s stack.Stack) bool
	 func isSyscallStack(s stack.Stack) bool
	 func isTestStack(s stack.Stack) bool
		isTestStack is a default filter installed to automatically skip goroutines
		that the testing package runs while the user's tests are running.

	 func isTraceStack(s stack.Stack) bool
	 func maxSleep(d time.Duration) Option
Package-Level Variables (total 2, neither is exported)

	/* 2 unexporteds ... *//* 2 unexporteds: */
	  var _osExit func(code int)
		Variables for stubbing in unit tests.

	  var _osStderr io.Writer
		Variables for stubbing in unit tests.


Package-Level Constants (only one, which is unexported)

	/* one unexported ... *//* one unexported: */
	const _defaultRetries = 20
		We retry up to 20 times if we can't find the goroutine that
		we are looking for. In between each attempt, we will sleep for
		a short while to let any running goroutines complete.

The pages are generated with Golds v0.4.9. (GOOS=linux GOARCH=amd64)