Enum AggregateError 

pub enum AggregateError<T: Error> {
    UserError(T),
    AggregateConflict,
    DatabaseConnectionError(Box<dyn Error + Send + Sync + 'static>),
    DeserializationError(Box<dyn Error + Send + Sync + 'static>),
    UnexpectedError(Box<dyn Error + Send + Sync + 'static>),
}

The base error for the framework.

Variants

UserError(T)

This is the error returned when a user violates a business rule. The payload within AggregateError::UserError should be used to pass information to inform the user of the nature of problem.

The UserErrorPayload struct has been provided as a reference implementation for this purpose.

Handling

In a Restful application this should translate to a 400 response status.

AggregateConflict

A command has been rejected due to a conflict with another command on the same aggregate instance. This is handled by optimistic locking in systems backed by an RDBMS.

Handling

In a Restful application this usually translates to a 503 or 429 response status, often with a Retry-After response header indicating that the user should try again.

DatabaseConnectionError(Box<dyn Error + Send + Sync + 'static>)

A error occurred while attempting to read or write from a database.

DeserializationError(Box<dyn Error + Send + Sync + 'static>)

A deserialization error occurred due to invalid JSON.

UnexpectedError(Box<dyn Error + Send + Sync + 'static>)

A technical error was encountered that prevented the command from being applied to the aggregate. In general the accompanying message should be logged for investigation rather than returned to the user.

Trait Implementations

impl<T: Debug + Error> Debug for AggregateError<T>

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

Formats the value using the given formatter.

impl<T> Display for AggregateError<T>

where T: Display + Error,

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

Formats the value using the given formatter.

impl<T: Error> Error for AggregateError<T>

where Self: Debug + Display,

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<T: Error> From<Error> for AggregateError<T>

fn from(err: Error) -> Self

Converts to this type from the input type.

impl<T: Error> From<PersistenceError> for AggregateError<T>

fn from(err: PersistenceError) -> Self

Converts to this type from the input type.