statushooks

package

v0.16.1-rc.3 Latest Latest Go to latest Published: Aug 30, 2022 License: AGPL-3.0 Imports: 8 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

View Source

var NullHooks = &NullStatusHook{}

func AddMessageRendererToContext(ctx context.Context, messageRenderer MessageRenderer) context.Context

func AddStatusHooksToContext(ctx context.Context, statusHooks StatusHooks) context.Context

func DisableStatusHooks(ctx context.Context) context.Context

func Done(ctx context.Context)

func Message(ctx context.Context, msgs ...string)

func SetStatus(ctx context.Context, msg string)

type MessageRenderer func(format string, a ...any)

func MessageRendererFromContext(ctx context.Context) MessageRenderer

type NullStatusHook struct{}

func (*NullStatusHook) Done()

func (*NullStatusHook) Message(...string)

func (*NullStatusHook) SetStatus(string)

type StatusHooks interface {
	SetStatus(string)
	Done()
	Message(...string)
}

func StatusHooksFromContext(ctx context.Context) StatusHooks

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

StatusSpinner is a struct which implements StatusHooks, and uses a spinner to display status messages

func NewStatusSpinner(opts ...StatusSpinnerOpt) *StatusSpinner

func (s *StatusSpinner) Done()

Done implements StatusHooks

func (s *StatusSpinner) Message(msgs ...string)

func (s *StatusSpinner) SetStatus(msg string)

SetStatus implements StatusHooks

func (s *StatusSpinner) UpdateSpinnerMessage(newMessage string)

UpdateSpinnerMessage updates the message of the given spinner

type StatusSpinnerOpt func(*StatusSpinner)

func WithDelay(delay time.Duration) StatusSpinnerOpt

func WithMessage(msg string) StatusSpinnerOpt