scan

type BareKind struct {
	Pos token.Position

	// Kind is the name of the kind, e.g. "ErrNotFound".
	Kind string

	// Ignored is set, if the call carries an ignore directive.
	Ignored bool
}

type BoundaryError struct {
	Pos token.Position

	// Responder is the response helper the error is handed to, e.g.
	// "response.BadRequest".
	Responder string

	// Callee is the function creating the error, e.g. "errors.New".
	Callee string

	// Ignored is set, if the call carries an ignore directive.
	Ignored bool
}

type DomainError struct {
	Pos token.Position

	// Kind is the name of the kind, e.g. "ErrNotFound". It is empty for an
	// error constructed with a nil kind, which carries a message for the user
	// without classifying it.
	Kind string

	// Reason is the name of the api.ErrorReason constant, e.g.
	// "ErrorReasonServerIsClusterMember", or empty, if the empty string was
	// passed. ReasonValue is the value of the constant.
	Reason      string
	ReasonValue string

	// ReasonUnresolved is set, if the reason is neither the empty string, nor a
	// constant declared in shared/api, nor an api.ErrorReason resolved
	// elsewhere.
	ReasonUnresolved bool

	// Message is the format string of the message for the user. Format is
	// false, if it is not a constant, in which case the message can not be
	// reported in the catalog.
	Message      string
	MessageConst bool

	// Hint is the format string of the hint, if WithHintf is called on the
	// error. HintConst is false, if it is not a constant.
	Hint      string
	HintConst bool
	HasHint   bool

	// DetailKeys are the keys passed to WithDetail, in the order they are
	// added. A key, which is not a constant, is reported as the empty string.
	DetailKeys []string

	// CauseIsKind is set, if the error passed to WithCause is a domain error
	// kind itself, which reclassifies the error.
	CauseIsKind bool
	CauseKind   string

	// Ignored is set, if the call carries an ignore directive.
	Ignored bool
}

type KindWrap struct {
	Pos token.Position

	// Callee is the function the kind is handed to, e.g. "fmt.Errorf".
	Callee string

	// Kind is the name of the kind, e.g. "ErrNotFound".
	Kind string

	// Ignored is set, if the call carries an ignore directive.
	Ignored bool
}

type Reason struct {
	Pos   token.Position
	Name  string
	Value string
}

type Result struct {
	// Errors are the domain.NewErrorf calls, in the order they were found.
	Errors []DomainError

	// KindWraps are the calls, which classify an error by handing a domain
	// error kind to something other than domain.NewErrorf.
	KindWraps []KindWrap

	// BoundaryErrors are the errors, which are created at the HTTP boundary
	// without a kind, so they reach the user as an internal server error.
	BoundaryErrors []BoundaryError

	// BareKinds are the places, which return a kind without a message of its
	// own, outside the layer, where a kind is a sentinel for the caller.
	BareKinds []BareKind

	// UnkindedErrors are the errors, which originate in the business logic
	// without a kind, so nothing says, whether they are meant for the user.
	UnkindedErrors []UnkindedError

	// UnknownConstructs are the constructors and the builder methods of the
	// domain package, which the scan does not know about, so the errors they
	// build would be checked by nothing.
	UnknownConstructs []UnknownConstruct

	// DeclaredReasons are the api.ErrorReason constants of shared/api.
	DeclaredReasons []Reason

	// UsedReasons are the reason constants referenced anywhere in the module,
	// keyed by the constant name.
	UsedReasons map[string]bool
}

type UnkindedError struct {
	Pos token.Position

	// Callee is the function creating the error, e.g. "fmt.Errorf".
	Callee string

	// Message is the constant format string of the error.
	Message string

	// Internal is set, if the error is declared internal by design.
	Internal bool

	// Ignored is set, if the call carries an ignore directive.
	Ignored bool
}

type UnknownConstruct struct {
	Pos token.Position

	// Name is the name of the function or the method, e.g. "NewSomethingErr".
	Name string

	// What says, what the name is, so the report can tell the reader, where to
	// teach the scan about it.
	What string
}