clierror

Documentation

Index

• type CLIError
  • func NewCLIError(err error, sanitizedMsg string) *CLIError
  • func (e *CLIError) Error() string
  • func (e *CLIError) SanitizedError() string
  • func (e *CLIError) SanitizedStack() string
• type PanicError
  • func NewPanicError(err error, stack []byte) *PanicError
  • func (p *PanicError) Error() string
  • func (p *PanicError) SanitizedError() string
  • func (p *PanicError) SanitizedStack() string
• type SanitizedError
• type WarningError
  • func NewWarning(warning string) WarningError
  • func NewWarningF(warning string, args ...any) WarningError
  • func (w WarningError) Error() string

Types

type CLIError

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

func NewCLIError

func NewCLIError(err error, sanitizedMsg string) *CLIError

func (*CLIError) Error

func (e *CLIError) Error() string

func (*CLIError) SanitizedError

func (e *CLIError) SanitizedError() string

func (*CLIError) SanitizedStack

func (e *CLIError) SanitizedStack() string

type PanicError

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

PanicError is used to collect goroutine panics into an error interface so that we can do type assertion on err checking.

func NewPanicError

func NewPanicError(err error, stack []byte) *PanicError

func (*PanicError) Error

func (p *PanicError) Error() string

func (*PanicError) SanitizedError

func (p *PanicError) SanitizedError() string

func (*PanicError) SanitizedStack

func (p *PanicError) SanitizedStack() string

type SanitizedError

type SanitizedError interface {
	SanitizedError() string
	SanitizedStack() string
}

SanitizedError allows errors to be wrapped with a sanitized message for sending upstream

type WarningError

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

WarningError is an error that adhears to the error interface but is used to convey a non-critical path in the application code. WarningError messages should be considered safe to display to the user.

func NewWarning

func NewWarning(warning string) WarningError

NewWarning returns a new WarningError using warning as the error string.

func NewWarningF

func NewWarningF(warning string, args ...any) WarningError

NewWarningF returns a new WarningError using the warning as a formatted string.

func (WarningError) Error

func (w WarningError) Error() string