util

Documentation

Index

• func ContextWithCancelOnSignals(ctx context.Context, sigs ...os.Signal) context.Context
• func CurrentServer() (string, error)
• func Die(err error, cause ...string)
• func Doc(doc string) string
• func EscapeAppsetFieldName(field string) string
• func WithSpinner(ctx context.Context, msg ...string) func()
• type AsyncRunner
  • func NewAsyncRunner(n int) *AsyncRunner
  • func (ar *AsyncRunner) Run(f func() error)
  • func (ar *AsyncRunner) Wait() error

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 CurrentServer

func CurrentServer() (string, error)

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 EscapeAppsetFieldName

func EscapeAppsetFieldName(field string) string

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.

Types

type AsyncRunner

type AsyncRunner struct {
	// contains filtered or unexported fields
}

func NewAsyncRunner

func NewAsyncRunner(n int) *AsyncRunner

NewAsyncRunner initializes a new AsyncRunner that can run up to n async operations.

func (*AsyncRunner) Run

func (ar *AsyncRunner) Run(f func() error)

Run runs another async operation

func (*AsyncRunner) Wait

func (ar *AsyncRunner) Wait() error

Wait waits for all async operations to finish and returns an error if one of the async operations returned an error, otherwise, returns nil.