package testlog

Import Path
	internal/testlog (on go.dev)

Dependency Relation
	imports 2 packages, and imported by one package

Involved Source Files

	    exit.go
	  d log.go
		Package testlog provides a back-channel communication path
		between tests and package os, so that cmd/go can see which
		environment variables and files a test consults.
Package-Level Type Names (only one, which is exported)

	/* sort exporteds by: alphabet | popularity */
	 type Interface (interface)
		Interface is the interface required of test loggers.
		The os package will invoke the interface's methods to indicate that
		it is inspecting the given environment variables or files.
		Multiple goroutines may call these methods simultaneously.

		Methods (total 4, all are exported)
			( Interface) Chdir(dir string)
			( Interface) Getenv(key string)
			( Interface) Open(file string)
			( Interface) Stat(file string)
		As Outputs Of (at least one exported)
			func Logger() Interface
		As Inputs Of (at least one exported)
			func SetLogger(impl Interface)


Package-Level Functions (total 7, all are exported)

	 func Getenv(name string)
		Getenv calls Logger().Getenv, if a logger has been set.

	 func Logger() Interface
		Logger returns the current test logger implementation.
		It returns nil if there is no logger.

	 func Open(name string)
		Open calls Logger().Open, if a logger has been set.

	 func PanicOnExit0() bool
		PanicOnExit0 reports whether to panic on a call to os.Exit(0).
		This is in the testlog package because, like other definitions in
		package testlog, it is a hook between the testing package and the
		os package. This is used to ensure that an early call to os.Exit(0)
		does not cause a test to pass.

	 func SetLogger(impl Interface)
		SetLogger sets the test logger implementation for the current process.
		It must be called only once, at process startup.

	 func SetPanicOnExit0(v bool)
		SetPanicOnExit0 sets panicOnExit0 to v.

	 func Stat(name string)
		Stat calls Logger().Stat, if a logger has been set.


Package-Level Variables (total 2, neither is exported)

	/* 2 unexporteds ... *//* 2 unexporteds: */
	  var logger atomic.Value
		logger is the current logger Interface.
		We use an atomic.Value in case test startup
		is racing with goroutines started during init.
		That must not cause a race detector failure,
		although it will still result in limited visibility
		into exactly what those goroutines do.

	  var panicOnExit0 struct{mu sync.Mutex; val bool}
		panicOnExit0 is the flag used for PanicOnExit0. This uses a lock
		because the value can be cleared via a timer call that may race
		with calls to os.Exit

The pages are generated with Golds v0.6.7. (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 @Go100and1 (reachable from the left QR code) to get the latest news of Golds.