status

package
v2.24.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 10, 2024 License: Apache-2.0 Imports: 7 Imported by: 1

Documentation

Index

Constants

View Source 
const (
	LevelTrace = iota
	LevelInfo
	LevelWarning
	LevelError
	LevelProgress
	LevelPrompt
)

Variables

This section is empty.

Functions

func Deprecation added in v2.15.0 

func Deprecation(ctx context.Context, key string, message string)

func Error 

func Error(ctx context.Context, status string)

func Errorf added in v2.20.8 

func Errorf(ctx context.Context, status string, args ...any)

func Flush added in v2.11.2 

func Flush(ctx context.Context)

func Info 

func Info(ctx context.Context, status string)

func InfoFallback 

func InfoFallback(ctx context.Context, status string)

func InfoFallbackf added in v2.20.8 

func InfoFallbackf(ctx context.Context, status string, args ...any)

func Infof added in v2.20.8 

func Infof(ctx context.Context, status string, args ...any)

func IsTraceEnabled added in v2.13.0 

func IsTraceEnabled(ctx context.Context) bool

func NewContext 

func NewContext(ctx context.Context, slh StatusHandler) context.Context

func Trace 

func Trace(ctx context.Context, status string)

func Tracef added in v2.20.8 

func Tracef(ctx context.Context, status string, args ...any)

func Warning 

func Warning(ctx context.Context, status string)

func WarningOnce added in v2.16.0 

func WarningOnce(ctx context.Context, key string, status string)

func WarningOncef added in v2.20.8 

func WarningOncef(ctx context.Context, key string, status string, args ...any)

func Warningf added in v2.20.8 

func Warningf(ctx context.Context, status string, args ...any)

Types

type EndResult 

type EndResult int
const (
	EndSuccess EndResult = iota
	EndWarning
	EndError
)

type Level added in v2.21.0 

type Level int

type LineRedirector added in v2.22.0 

type LineRedirector struct {
	io.WriteCloser
	// contains filtered or unexported fields
}

func NewLineRedirector 

func NewLineRedirector(cb func(line string)) *LineRedirector

func (*LineRedirector) Close added in v2.22.0 

func (lr *LineRedirector) Close() error

func (*LineRedirector) Done added in v2.22.0 

func (lr *LineRedirector) Done() <-chan struct{}

type MultiLineStatusHandler 

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

func NewMultiLineStatusHandler 

func NewMultiLineStatusHandler(ctx context.Context, out io.Writer, enableColor bool, trace bool) *MultiLineStatusHandler

func (*MultiLineStatusHandler) Flush added in v2.11.2 

func (s *MultiLineStatusHandler) Flush()

func (*MultiLineStatusHandler) IsTraceEnabled added in v2.13.0 

func (s *MultiLineStatusHandler) IsTraceEnabled() bool

func (*MultiLineStatusHandler) Message added in v2.21.0 

func (s *MultiLineStatusHandler) Message(level Level, message string)

func (*MultiLineStatusHandler) MessageFallback added in v2.21.0 

func (s *MultiLineStatusHandler) MessageFallback(level Level, message string)

func (*MultiLineStatusHandler) SetTrace added in v2.10.1 

func (s *MultiLineStatusHandler) SetTrace(trace bool)

func (*MultiLineStatusHandler) StartStatus 

func (s *MultiLineStatusHandler) StartStatus(level Level, total int, message string) StatusLine

func (*MultiLineStatusHandler) Stop 

func (s *MultiLineStatusHandler) Stop()

type NoopStatusHandler added in v2.11.0 

type NoopStatusHandler struct {
}

func (NoopStatusHandler) Flush added in v2.11.2 

func (n NoopStatusHandler) Flush()

func (NoopStatusHandler) IsTerminal added in v2.12.4 

func (n NoopStatusHandler) IsTerminal() bool

func (NoopStatusHandler) IsTraceEnabled added in v2.13.0 

func (n NoopStatusHandler) IsTraceEnabled() bool

func (NoopStatusHandler) Message added in v2.21.0 

func (n NoopStatusHandler) Message(level Level, message string)

func (NoopStatusHandler) MessageFallback added in v2.21.0 

func (n NoopStatusHandler) MessageFallback(level Level, message string)

func (NoopStatusHandler) SetTrace added in v2.11.0 

func (n NoopStatusHandler) SetTrace(trace bool)

func (NoopStatusHandler) StartStatus added in v2.11.0 

func (n NoopStatusHandler) StartStatus(level Level, total int, message string) StatusLine

func (NoopStatusHandler) Stop added in v2.11.0 

func (n NoopStatusHandler) Stop()

type NoopStatusLine added in v2.11.0 

type NoopStatusLine struct {
}

func (NoopStatusLine) End added in v2.11.0 

func (n NoopStatusLine) End(result EndResult)

func (NoopStatusLine) Increment added in v2.11.0 

func (n NoopStatusLine) Increment()

func (NoopStatusLine) SetTotal added in v2.11.0 

func (n NoopStatusLine) SetTotal(total int)

func (NoopStatusLine) Update added in v2.11.0 

func (n NoopStatusLine) Update(message string)

type Option 

type Option func(s *StatusContext)

func WithLevel added in v2.21.0 

func WithLevel(level Level) Option

func WithPrefix 

func WithPrefix(prefix string) Option

func WithStatus 

func WithStatus(message string) Option

func WithStatusf added in v2.20.8 

func WithStatusf(message string, args ...any) Option

func WithTotal 

func WithTotal(t int) Option

type StatusContext 

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

StatusContext is used to report user-facing status/progress

func Start 

func Start(ctx context.Context, status string) *StatusContext

func StartWithOptions 

func StartWithOptions(ctx context.Context, opts ...Option) *StatusContext

func Startf added in v2.20.8 

func Startf(ctx context.Context, status string, args ...any) *StatusContext

func (*StatusContext) Failed 

func (s *StatusContext) Failed()

func (*StatusContext) FailedWithMessage 

func (s *StatusContext) FailedWithMessage(msg string)

func (*StatusContext) FailedWithMessagef added in v2.20.8 

func (s *StatusContext) FailedWithMessagef(msg string, args ...any)

func (*StatusContext) Increment 

func (s *StatusContext) Increment()

func (*StatusContext) InfoFallback 

func (s *StatusContext) InfoFallback(message string)

func (*StatusContext) InfoFallbackf added in v2.20.8 

func (s *StatusContext) InfoFallbackf(message string, args ...any)

func (*StatusContext) SetTotal 

func (s *StatusContext) SetTotal(total int)

func (*StatusContext) Success 

func (s *StatusContext) Success()

func (*StatusContext) Update 

func (s *StatusContext) Update(message string)

func (*StatusContext) UpdateAndInfoFallback 

func (s *StatusContext) UpdateAndInfoFallback(message string)

func (*StatusContext) UpdateAndInfoFallbackf added in v2.20.8 

func (s *StatusContext) UpdateAndInfoFallbackf(message string, args ...any)

func (*StatusContext) Updatef added in v2.20.8 

func (s *StatusContext) Updatef(message string, args ...any)

func (*StatusContext) Warning 

func (s *StatusContext) Warning()

type StatusHandler 

type StatusHandler interface {
	IsTraceEnabled() bool

	Stop()
	Flush()
	StartStatus(level Level, total int, message string) StatusLine

	Message(level Level, message string)
	MessageFallback(level Level, message string)
}

func FromContext 

func FromContext(ctx context.Context) StatusHandler

func NewSimpleStatusHandler 

func NewSimpleStatusHandler(cb func(level Level, message string), trace bool) StatusHandler

type StatusLine 

type StatusLine interface {
	SetTotal(total int)
	Increment()

	Update(message string)
	End(result EndResult)
}

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.