debug

Documentation

Overview

Package debug provides utilities for debugging purposes.

Index

• Variables
• func GetDebug() bool
• func GetStacktrace() bool
• func GetTitle() string
• func Print(message ...any)
• func Println(message ...any)
• func ResetTitle()
• func SetDebug(enabled bool)
• func SetStacktrace(enabled bool)
• func SetTitle(title string)

Variables

var (
	Title string = defaultTitle
)

Functions

func GetDebug

func GetDebug() bool

Get the current debug status.

func GetStacktrace

func GetStacktrace() bool

Get the current stacktrace status.

func GetTitle

func GetTitle() string

Gets the current title of the debug message.

func Print

func Print(message ...any)

Print prints the given message to the standard output.

func Println

func Println(message ...any)

Println prints the given message to the standard output, followed by a newline character. Note: Println should not be necessary, but it is included in case it is needed.

func ResetTitle

func ResetTitle()

Resets the title of the debug message to the default value.

func SetDebug

func SetDebug(enabled bool)

Toggle the debug regardless of the flag.

func SetStacktrace

func SetStacktrace(enabled bool)

Toggle the stacktrace regardless of the flag.

func SetTitle

func SetTitle(title string)

Sets the title of the debug message. note this currently is set globally and will affect all debug messages. it is reccomended to use this function at the start of a function followed by `defer debug.ResetTitle()`