Struct CqrsError

Source

pub struct CqrsError(/* private fields */);

Expand description

Unified error for API responses.

This is a thin wrapper around Box<CqrsErrorData> to keep Result<_, CqrsError> small on the stack. Access fields via Deref (e.g. err.domain, err.code).

§JSON Format

{
  "domain": "plan",
  "code": "PLAN_NOT_FOUND",
  "internalCode": 4001,
  "message": "Tenant with ID 'abc' not found",
  "details": { "id": "abc" },
  "requestId": "req-123"
}

Implementations§

Source §

impl CqrsError

Source

pub fn from_code<C: CqrsErrorCode>(code: &C, message: impl Into<String>) -> Self

Create a CqrsError from any domain error code.

Source

pub fn with_details(self, details: Value) -> Self

Add additional details to the error.

Source

pub fn with_request_id(self, request_id: impl Into<String>) -> Self

Add a request ID for tracing.

Source

pub fn with_request_id_if_absent(self, request_id: impl Into<String>) -> Self

Add a request ID unless the error already carries one (empty ids are ignored). Used by the REST layer to stamp errors with the crate::CqrsContext request id on their way out.

Source

pub fn with_type_uri(self, type_uri: impl Into<String>) -> Self

Override the type member of the RFC 9457 problem document for this error, bypassing both the configured base URI and the default urn:cqrs-error:{domain}:{code}.

Source

pub fn http_status(&self) -> StatusCode

Get the HTTP status code for this error.

Source

pub fn to_problem(&self) -> ProblemDetails

Render this error as an RFC 9457 problem document.

Available regardless of the problem-json feature, which only controls what the built-in Axum routers emit.

Source

pub fn not_found(message: impl Into<String>) -> Self

Create a generic not found error.

Source

pub fn validation(message: impl Into<String>) -> Self

Create a generic validation error.

Source

pub fn internal(message: impl Into<String>) -> Self

Create a generic internal error.

Source

pub fn conflict(message: impl Into<String>) -> Self

Create a generic conflict error.

Source

pub fn unauthorized(message: impl Into<String>) -> Self

Create a generic unauthorized error.

Source

pub fn forbidden(message: impl Into<String>) -> Self

Create a generic forbidden error.

Source

pub fn gone(message: impl Into<String>) -> Self

Create a generic gone error (410).

Source

pub fn unprocessable(message: impl Into<String>) -> Self

Create a generic unprocessable entity error (422).

Use this instead of Self::validation when the request is syntactically valid but semantically rejected.

Source

pub fn precondition_failed(message: impl Into<String>) -> Self

Create a generic precondition failed error (412).

Source

pub fn precondition_required(message: impl Into<String>) -> Self

Create a generic precondition required error (428).

Source

pub fn unsupported_media_type(message: impl Into<String>) -> Self

Create a generic unsupported media type error (415).

Source

pub fn payload_too_large(message: impl Into<String>) -> Self

Create a generic payload too large error (413).

Source

pub fn too_many_requests(message: impl Into<String>) -> Self

Create a generic too many requests error (429).

Source

pub fn not_implemented(message: impl Into<String>) -> Self

Create a generic not implemented error (501).

Source

pub fn service_unavailable(message: impl Into<String>) -> Self

Create a generic service unavailable error (503).

Source

pub fn user_error(e: impl Display) -> Self

Create a user/domain error.

Source

pub fn database_error(e: impl Display) -> Self

Create a database error.

Source

pub fn serialization_error(e: impl Display) -> Self

Create a serialization error.

Source

pub fn concurrency_error() -> Self

Create a concurrency/version conflict error.

Source

pub fn aggregate_not_found(id: &str) -> Self

Create an aggregate not found error.

Source

pub fn aggregate_already_exists(id: &str) -> Self

Create an aggregate already exists error.

Source

pub fn from_status(status: StatusCode, message: impl Into<String>) -> Self

Create an error from an HTTP status code and message.

The status is always preserved: statuses without a dedicated GenericErrorCode variant fall back to GenericErrorCode::Other (code GENERIC_HTTP_<status>) rather than being degraded to 500.