output

Documentation

Index

• func HumanElapsed(start time.Time) time.Duration
• func Logf(format string, a ...any)
• func SetOutputOptions(verb Verbosity, animation bool)
• func WithProgress(name string, fn func() error) error
• func WithProgressParallel(wg *sync.WaitGroup, name string, c *uint64, n uint64)
• type Options
• type Verbosity

Functions

func HumanElapsed

func HumanElapsed(start time.Time) time.Duration

HumanElapsed returns the time elapsed since the given start time truncated to 100x the highest non-zero duration unit (ns, us, ms, ...). This tends to create very short duration strings when printed (e.g. 725.8ms) without having to fiddle too much with

func Logf

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

func SetOutputOptions

func SetOutputOptions(verb Verbosity, animation bool)

func WithProgress

func WithProgress(name string, fn func() error) error

WithProgress prints a spinner while the given function is active.

func WithProgressParallel

func WithProgressParallel(wg *sync.WaitGroup, name string, c *uint64, n uint64)

WithProgressParallel will continuously print progress to stdout until the given wait group counter goes to zero. Progress is determined by the values of `c` (number of tasks completed) and the value `n` (total number of tasks).

Types

type Options

type Options struct {
	Verbosity      Verbosity
	ShowAnimations bool
}

type Verbosity

type Verbosity int

const (
	NoOutput Verbosity = iota
	DefaultOutput
	VerboseOutput
	VeryVerboseOutput
	VeryVeryVerboseOutput
)