Struct CqrsError 

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

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

impl CqrsError

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

Create a CqrsError from any domain error code.

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

Add additional details to the error.

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

Add a request ID for tracing.

pub fn http_status(&self) -> StatusCode

Get the HTTP status code for this error.

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

Create a generic not found error.

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

Create a generic validation error.

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

Create a generic internal error.

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

Create a generic conflict error.

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

Create a generic unauthorized error.

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

Create a generic forbidden error.

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

Create a user/domain error.

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

Create a database error.

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

Create a serialization error.

pub fn concurrency_error() -> Self

Create a concurrency/version conflict error.

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

Create an aggregate not found error.

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

Create an aggregate already exists error.

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

Create an error from an HTTP status code and message.

Trait Implementations

impl Clone for CqrsError

fn clone(&self) -> CqrsError

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CqrsError

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for CqrsError

type Target = CqrsErrorData

The resulting type after dereferencing.

fn deref(&self) -> &CqrsErrorData

Dereferences the value.

impl DerefMut for CqrsError

fn deref_mut(&mut self) -> &mut CqrsErrorData

Mutably dereferences the value.

impl<'de> Deserialize<'de> for CqrsError

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for CqrsError

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Error for CqrsError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<Error> for CqrsError

fn from(e: Error) -> Self

Converts to this type from the input type.

impl Serialize for CqrsError

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.