mu

README

Go package that contains miscellaneous utility functions.

Documentation

Overview

Package mu (mini utility) contains miscellaneous utility functions that are generally useful for most projects.

Index

• func BUG(format string, a ...any)
• func BoolToInt(b bool) int
• func Fatalf(format string, a ...any)
• func IntToBool(i int) bool
• func Panicf(format string, a ...any)
• func UNUSED(v ...any)

Functions

func BUG

func BUG(format string, a ...any)

BUG simply invokes Panicf, but prepends the message with "bug: "

func BoolToInt

func BoolToInt(b bool) int

BoolToInt converts a bool to int. It returns 1 if b is true and 0 if b is false.

func Fatalf

func Fatalf(format string, a ...any)

Fatalf writes a message to stderr, and then calls os.Exit(1). Arguments are handled in the manner of fmt.Fprintf. If format does not end in a newline, this function adds one.

func IntToBool

func IntToBool(i int) bool

IntToBool converts an int to a bool. It returns true if i is nonzero, and false if i is zero.

func Panicf

func Panicf(format string, a ...any)

Panicf invokes panic() with a message. Arguments are handled in the manner of fmt.Sprintf.

func UNUSED

func UNUSED(v ...any)

UNUSED is a noop function that is primarily used during development to silence build errors of the form "variable x declared and not used." UNUSED takes a variable number of arguments, and thus may silence such errors for multiple variables with a single call.

Example:

a, b, err = foo()
if err != nil {
    mu.Fatalf("error: %v", err)
}
mu.UNUSED(a, b)