flyerr

package

v0.4.96 Latest Latest Go to latest Published: Aug 31, 2026 License: Apache-2.0 Imports: 4 Imported by: 0

Details

This section is empty.

View Source

var ErrAbort = errors.New("abort")

ErrAbort is an error for when the CLI aborts

func GetErrorDescription(err error) string

func GetErrorDocUrl(err error) string

func GetErrorSuggestion(err error) string

func IsCancelledError(err error) bool

func PrintCLIOutput(err error)

func WithSuggestion(err error, suggestion string) error

WithSuggestion decorates err with user-facing advice while preserving its wrapping chain. A nil error or empty suggestion is returned unchanged.

type ErrorDescription interface {
	error
	Description() string
}

ErrorDescription is an error with a detailed description that will be printed before the CLI exits

type ErrorSuggestion interface {
	error
	Suggestion() string
}

ErrorSuggestion is an error with suggested next steps that will be printed before the CLI exits

type FlyDocUrl interface {
	DocURL() string
}

type GenericErr struct {
	Err      string
	Descript string
	Suggest  string
	DocUrl   string
}

func (e GenericErr) Description() string

func (e GenericErr) Error() string

func (e GenericErr) FlyDocURL() string

func (e GenericErr) Suggestion() string