util

Documentation

Index

• func ContextWithCancelOnSignals(ctx context.Context, sigs ...os.Signal) context.Context
• func Die(err error, cause ...string)
• func Doc(doc string) string
• func WithSpinner(ctx context.Context, msg ...string) func()

Functions

func ContextWithCancelOnSignals

func ContextWithCancelOnSignals(ctx context.Context, sigs ...os.Signal) context.Context

ContextWithCancelOnSignals returns a context that is canceled when one of the specified signals are received

func Die

func Die(err error, cause ...string)

Die panics it the error is not nil. If a cause string is provided it will be displayed in the error message.

func Doc

func Doc(doc string) string

Doc returns a string where all the '<BIN>' are replaced with the binary name and all the '\t' are replaced with a uniformed indentation using space.

func WithSpinner

func WithSpinner(ctx context.Context, msg ...string) func()

WithSpinner create a spinner that prints a message and canceled if the given context is canceled or the returned stop function is called.