Help us shape the future of Go! Take the 2026 Go Developer Survey

debug

package
v1.21.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 19, 2026 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Debug

type Debug interface {
	// Printf prints, with a short file:line-number prefix
	Printf(format string, args ...any)
	// Writer returns the writer being written to, which may be
	// `io.Discard` if no debug output is requested.
	Writer() io.Writer

	// Output allows tweaking the calldepth used for figuring
	// out which Go source file location is the interesting one,
	// i.e., which is included in the debug message. Useful for
	// setting up local helper methods.
	Output(calldepth int, s string) error
}

Debug allows printing debug messages.

func Discard

func Discard() Debug

Discard returns a new `Debug` that doesn't output anything. Note: We're not implementing the methods here with noop stubs since doing this way, we can propagate the "discarding" via `(Debug).Writer()`.

func New

func New(sink io.Writer) Debug

New returns a new `Debug` outputting to the passed `sink`.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL