debug

Documentation

Overview

Package debug provides logging of debug information.

This package is heavily based on github.com/restic/restic/internal/debug

Index

• Variables
• func IsEnabled() bool
• func Log(f string, args ...any)
• func LogN(offset int, f string, args ...any)
• func ModuleVersion(m string) semver.Version
• func V(n int) v

Variables

var (
	// Stdout is exported for tests.
	Stdout io.Writer = os.Stdout
	// Stderr is exported for tests.
	Stderr io.Writer = os.Stderr
	// LogWriter is exposed for consuming extra command output, if needed.
	LogWriter io.Writer = io.Discard
)

Functions

func IsEnabled

func IsEnabled() bool

IsEnabled returns true if debug logging was enabled.

func Log

func Log(f string, args ...any)

Log logs a statement to Stderr (unless filtered) and the debug log file (if enabled).

func LogN

func LogN(offset int, f string, args ...any)

LogN logs a statement to Stderr (unless filtered) and the debug log file (if enabled). The offset will be applied to the runtime position.

func ModuleVersion

func ModuleVersion(m string) semver.Version

ModuleVersion the version of the named import.

func V

func V(n int) v

V returns a logger at the given verbosity level.