Skip to main content

OutboxMessage

Struct OutboxMessage 

Source
pub struct OutboxMessage {
Show 14 fields pub message_id: OutboxMessageId, pub stream_id: StreamId, pub process_id: ProcessId, pub tenant_id: TenantId, pub correlation_id: CorrelationId, pub conversation_id: ConversationId, pub causation_event_id: EventId, pub message_type: Box<str>, pub recipient: Box<str>, pub payload: Value, pub payload_schema: Option<Box<str>>, pub created_at: OffsetDateTime, pub deliver_after: Option<OffsetDateTime>, pub attempt_count: u32,
}
Expand description

An outbound message queued for delivery via AS4 or another channel.

The message carries both routing information (recipient, message_type) and full correlation metadata so the delivery worker can trace every send back to the domain event that caused it.

Construct with OutboxMessage::new and optionally chain OutboxMessage::with_deliver_after for deferred delivery.

Fields§

§message_id: OutboxMessageId

Stable unique identifier for this outbox entry.

§stream_id: StreamId

The process stream that produced this outbound message.

§process_id: ProcessId

The MaKo process instance.

§tenant_id: TenantId

The tenant sending this message.

§correlation_id: CorrelationId

Propagated correlation root from the triggering event.

§conversation_id: ConversationId

Business conversation this message belongs to (e.g. UTILMD ↔ APERAK).

§causation_event_id: EventId

The persisted event that directly caused this outbound message.

§message_type: Box<str>

EDIFACT or XML message type (e.g. "APERAK", "CONTRL", "UTILMD").

§recipient: Box<str>

GLN or EIC code of the intended recipient market participant.

§payload: Value

Serialized message payload.

Typically a JSON-encoded string of EDIFACT bytes or a structured JSON object for non-EDIFACT channels.

§payload_schema: Option<Box<str>>

BO4E JSON Schema URL that validates payload, if present.

None for raw EDIFACT or untyped payloads. Set by domain workflows via PendingOutbox::with_schema when the payload is a BO4E object.

§created_at: OffsetDateTime

When this entry was created.

§deliver_after: Option<OffsetDateTime>

Do not deliver before this time.

None means deliver immediately (as soon as the delivery worker runs).

§attempt_count: u32

Number of delivery attempts so far. Starts at 0, incremented by OutboxStore::reschedule.

Implementations§

Source§

impl OutboxMessage

Source

pub fn new( stream_id: StreamId, process_id: ProcessId, tenant_id: TenantId, correlation_id: CorrelationId, conversation_id: ConversationId, causation_event_id: EventId, message_type: impl Into<Box<str>>, recipient: impl Into<Box<str>>, payload: Value, ) -> Self

Construct a new outbox message.

message_id and created_at are generated automatically. attempt_count is initialized to 0.

Call OutboxMessage::with_deliver_after to schedule deferred delivery.

Source

pub fn with_deliver_after(self, deliver_after: OffsetDateTime) -> Self

Set a deferred delivery time.

The message will not appear in OutboxStore::pending results until now >= deliver_after.

Trait Implementations§

Source§

impl Clone for OutboxMessage

Source§

fn clone(&self) -> OutboxMessage

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for OutboxMessage

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for OutboxMessage

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for OutboxMessage

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more