errors

type Code interface {
	// ErrorCode returns the numeric code associated with the error.
	ErrorCode() int32
}

type Error interface {
	// WithCode attaches a custom numeric code to the error.
	WithCode(code Code) Error

	// WithAttributes adds custom log attributes to be included in the log
	// entry generated for this error.
	WithAttributes(attrs ...logger.Attribute) Error

	// Submit finalizes the error, logs it, and converts it into a standard
	// Go error for return from a handler.
	Submit(ctx context.Context) error

	// Kind returns the classification of the error (e.g., "not_found",
	// "internal", "invalid_argument").
	Kind() string
}

type ErrorAPI interface {
	// RPC should be used when an error is received from an RPC call to
	// another service. The destination identifies the remote service.
	RPC(err error, destination string) Error

	// InvalidArgument should be used when a handler receives invalid input
	// parameters.
	InvalidArgument(err error) Error

	// FailedPrecondition should be used when a required condition is not met
	// for an operation to proceed.
	FailedPrecondition(message string) Error

	// NotFound should be used when a requested resource could not be located.
	NotFound() Error

	// Internal should be used when an unexpected internal behavior or failure
	// occurs in the service.
	Internal(err error) Error

	// PermissionDenied should be used when a client is not authorized to
	// access the requested resource.
	PermissionDenied() Error

	// Custom should be used for error cases that do not match any of the
	// predefined types. These are treated as internal errors by default.
	Custom(msg string) Error
}