hexeract-outbox 0.5.0

Transactional outbox pattern primitives for the Hexeract messaging framework
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

use serde::Serialize;
use serde::de::DeserializeOwned;

/// Marker trait for a domain event that can flow through the outbox.
///
/// Implementors are serialized to JSON when persisted and deserialized
/// back when dispatched to a handler.
///
/// # Convention
///
/// Pick a stable, kebab-case identifier scoped by bounded context for
/// [`Event::EVENT_TYPE`], for example `"users.registered"` or
/// `"orders.placed"`. Changing this value after rows have been persisted
/// breaks dispatch.
///
/// # Example
///
/// ```
/// use hexeract_outbox::Event;
/// use serde::{Deserialize, Serialize};
///
/// #[derive(Debug, Serialize, Deserialize)]
/// struct UserRegistered {
///     user_id: uuid::Uuid,
/// }
///
/// impl Event for UserRegistered {
///     const EVENT_TYPE: &'static str = "users.registered";
/// }
///
/// assert_eq!(UserRegistered::EVENT_TYPE, "users.registered");
/// ```
pub trait Event: Send + Sync + 'static + Serialize + DeserializeOwned {
    /// Stable identifier of this event type used for storage and routing.
    const EVENT_TYPE: &'static str;
}