statushooks

package

v0.1.0-rc.5 Latest Latest Go to latest Published: Jan 29, 2025 License: AGPL-3.0 Imports: 10 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/turbot/tailpipe

Links

Open Source Insights

Documentation ¶

Index ¶

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)
func Show(ctx context.Context)
func Warn(ctx context.Context, warning string)
type NullStatusHook
type StatusHooks
- func StatusHooksFromContext(ctx context.Context) StatusHooks
type StatusSpinner
- func NewStatusSpinnerHook(opts ...StatusSpinnerOpt) *StatusSpinner
type StatusSpinnerOpt
- func WithDelay(delay time.Duration) StatusSpinnerOpt
- func WithMessage(msg string) StatusSpinnerOpt

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func AddStatusHooksToContext ¶

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

func DisableStatusHooks ¶

func DisableStatusHooks(ctx context.Context) context.Context

func Done ¶

func Done(ctx context.Context)

func Message ¶

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

func SetStatus ¶

func SetStatus(ctx context.Context, msg string)

func Show ¶

func Show(ctx context.Context)

func Warn ¶

func Warn(ctx context.Context, warning string)

Types ¶

type NullStatusHook ¶

type NullStatusHook struct{}

func (*NullStatusHook) Hide ¶

func (*NullStatusHook) Hide()

func (*NullStatusHook) Message ¶

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

func (*NullStatusHook) SetStatus ¶

func (*NullStatusHook) SetStatus(string)

func (*NullStatusHook) Show ¶

func (*NullStatusHook) Show()

func (*NullStatusHook) Warn ¶

func (*NullStatusHook) Warn(string)

type StatusHooks ¶

type StatusHooks interface {
	SetStatus(string)
	Show()
	Warn(string)
	Hide()
	Message(...string)
}

var NullHooks StatusHooks = &NullStatusHook{}

func StatusHooksFromContext ¶

func StatusHooksFromContext(ctx context.Context) StatusHooks

type StatusSpinner ¶

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

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

func NewStatusSpinnerHook ¶

func NewStatusSpinnerHook(opts ...StatusSpinnerOpt) *StatusSpinner

this is used in the root command to setup a default cmd execution context with a status spinner built in to update this, use the statushooks.AddStatusHooksToContext

We should never create a StatusSpinner directly. To use a spinner DO NOT use a StatusSpinner directly, since using it may have unintended side-effect around the spinner lifecycle

func (*StatusSpinner) Hide ¶

func (s *StatusSpinner) Hide()

Hide implements StatusHooks

func (*StatusSpinner) Message ¶

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

func (*StatusSpinner) SetStatus ¶

func (s *StatusSpinner) SetStatus(msg string)

SetStatus implements StatusHooks

func (*StatusSpinner) Show ¶

func (s *StatusSpinner) Show()

func (*StatusSpinner) UpdateSpinnerMessage ¶

func (s *StatusSpinner) UpdateSpinnerMessage(newMessage string)

UpdateSpinnerMessage updates the message of the given spinner

func (*StatusSpinner) Warn ¶

func (s *StatusSpinner) Warn(msg string)

type StatusSpinnerOpt ¶

type StatusSpinnerOpt func(*StatusSpinner)

func WithDelay ¶

func WithDelay(delay time.Duration) StatusSpinnerOpt

func WithMessage ¶

func WithMessage(msg string) StatusSpinnerOpt

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL