errors

Documentation

Index

• Constants
• func GetErrorMessage(err error) string
• func LabelUserError(messageFormat string, messageA []interface{}) string
• func WrapUserError(err error) error
• type UserError
  • func (e *UserError) Error() string
  • func (e *UserError) Unwrap() error

Constants

const UserErrorLabel = "[User error] "

Functions

func GetErrorMessage

func GetErrorMessage(err error) string

GetErrorMessage returns the error message with the user error label if it is of type user error

func LabelUserError

func LabelUserError(messageFormat string, messageA []interface{}) string

LabelUserError labels the failure RunStatus message if any of its error messages has been wrapped as an UserError. It indicates that the user is responsible for an error. See github.com/tektoncd/pipeline/blob/main/docs/pipelineruns.md#marking-off-user-errors for more details.

func WrapUserError

func WrapUserError(err error) error

WrapUserError wraps the original error with the user error label

Types

type UserError

type UserError struct {
	Reason   string
	Original error
}

func (*UserError) Error

func (e *UserError) Error() string

Error returns the original error message. This implements the error.Error interface.

func (*UserError) Unwrap

func (e *UserError) Unwrap() error

Unwrap returns the original error without the Reason annotation. This is intended to support usage of errors.Is and errors.As with Errors.