errors

README

errors

errors is the collection of error types that can be used by any submodule of the Transfer and are recognised by its common components.

Currently, not all such errors are stored here — a prominent example is abstract.FatalError.

Documentation

Index

• Constants
• Variables
• func CategorizedErrorf(category categories.Category, format string, a ...any) error
• func EqualCauses(a error, b error) bool
• func ExtractShortStackTrace(err error) string
• func LogFatalError(err error, transferID string, dstType abstract.ProviderType, ...)
• func NewStatusMessageError(msg *coordinator.StatusMessage) error
• func ToTransferStatusMessage(err error) *coordinator.StatusMessage
• type Categorized

Constants

const (
	KeyTransferID = "transfer_id"
	KeyDstType    = "labels.dst_type"
	KeySrcType    = "labels.src_type"
	Category      = "labels.category"
	Code          = "labels.code"
)

Variables

var UnspecifiedCode = coded.Register("unspecified")

Functions

func CategorizedErrorf

func CategorizedErrorf(category categories.Category, format string, a ...any) error

CategorizedErrorf produces a xerrors-wrapped error with a given assigned category

func EqualCauses

func EqualCauses(a error, b error) bool

EqualCauses checks if two errors have the same cause. This is determined by an heuristic defined in this function.

func ExtractShortStackTrace

func ExtractShortStackTrace(err error) string

func LogFatalError

func LogFatalError(err error, transferID string, dstType abstract.ProviderType, srcType abstract.ProviderType)

func NewStatusMessageError

func NewStatusMessageError(msg *coordinator.StatusMessage) error

func ToTransferStatusMessage

func ToTransferStatusMessage(err error) *coordinator.StatusMessage

Types

type Categorized

type Categorized interface {
	error
	xerrors.Wrapper

	Category() categories.Category
}

Categorized is an error with an attached category