statushooks

May 18, 2023

Changes in this version

+ func Show(ctx context.Context)

+ func Warn(ctx context.Context, warning string)

type NullStatusHook

+ func (*NullStatusHook) Hide()

+ func (*NullStatusHook) Show()

+ func (*NullStatusHook) Warn(string)

type StatusHooks

+ Hide func()

+ Show func()

+ Warn func(string)

type StatusSpinner

+ func NewStatusSpinnerHook(opts ...StatusSpinnerOpt) *StatusSpinner

+ func (s *StatusSpinner) Hide()

+ func (s *StatusSpinner) Show()

+ func (s *StatusSpinner) Warn(msg string)

Nov 8, 2022

Changes in this version

+ var NullProgress = &NullSnapshotProgress

+ func AddSnapshotProgressToContext(ctx context.Context, snapshotProgress SnapshotProgress) context.Context

+ func SnapshotError(ctx context.Context)

+ func UpdateSnapshotProgress(ctx context.Context, completedRows int)

+ type NullSnapshotProgress struct

+ func (*NullSnapshotProgress) UpdateErrorCount(context.Context, int)

+ func (*NullSnapshotProgress) UpdateRowCount(context.Context, int)

+ type SnapshotProgress interface

+ UpdateErrorCount func(context.Context, int)

+ UpdateRowCount func(context.Context, int)

+ func SnapshotProgressFromContext(ctx context.Context) SnapshotProgress

+ type SnapshotProgressReporter struct

+ func NewSnapshotProgressReporter(target string) *SnapshotProgressReporter

+ func (r *SnapshotProgressReporter) UpdateErrorCount(ctx context.Context, errors int)

+ func (r *SnapshotProgressReporter) UpdateRowCount(ctx context.Context, rows int)

Aug 24, 2022

Changes in this version

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

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

+ func MessageRendererFromContext(ctx context.Context) MessageRenderer

Jul 5, 2022

Changes in this version

+ var NullHooks = &NullStatusHook

+ 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 NullStatusHook struct

+ func (*NullStatusHook) Done()

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

+ func (*NullStatusHook) SetStatus(string)

+ type StatusHooks interface

+ Done func()

+ Message func(...string)

+ SetStatus func(string)

+ func StatusHooksFromContext(ctx context.Context) StatusHooks

+ type StatusSpinner struct

+ func NewStatusSpinner(opts ...StatusSpinnerOpt) *StatusSpinner

+ func (s *StatusSpinner) Done()

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

+ func (s *StatusSpinner) SetStatus(msg string)

+ func (s *StatusSpinner) UpdateSpinnerMessage(newMessage string)

+ type StatusSpinnerOpt func(*StatusSpinner)

+ func WithDelay(delay time.Duration) StatusSpinnerOpt

+ func WithMessage(msg string) StatusSpinnerOpt