Struct WriteCtx 

#[non_exhaustive]
pub struct WriteCtx {
    pub correlation_id: String,
    pub causation_id: Option<String>,
    pub actor: Option<String>,
    pub company_id: Option<Uuid>,
    pub outbox_schema: Option<String>,
}

What a write hook knows about the write it runs in.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

correlation_id: String

The correlation id of the request (its x-correlation-id header, else the audit attribution’s, else one minted for the write). Staged events carry it.

causation_id: Option<String>

The id of the event, trigger or workflow step that caused this write, when one did. Staged events carry it as their causation_id.

actor: Option<String>

Who is writing: the request’s audit attribution; None for a job or an unscoped caller.

company_id: Option<Uuid>

The company the request is scoped to, when it is. Events of an entity with no company of its own are staged under it.

outbox_schema: Option<String>

The Postgres schema whose outbox_events table stage writes to, as the hooks named it (WriteHooks::outbox_schema).

Implementations

impl WriteCtx

pub fn current(outbox_schema: Option<&str>) -> Self

The context of a write made now, in the current task.

pub fn company_or_nil(&self) -> Uuid

The company to stage an event under when the entity names none: the request’s, else the nil uuid. The outbox table requires a value, and under org-unit tenancy the fence is the org unit the table fills from the acting unit, not this column.

pub fn company_of(&self, row: &Value) -> Uuid

The company an event of row is staged under: the row’s own company_id, else the request’s, else the nil uuid.

pub async fn stage(&self, record: OutboxRecord) -> ServiceResult<()>

Stage record on the write’s transaction. It commits with the write and vanishes if the write rolls back. The record takes this context’s correlation id (and causation id) unless it already carries one.

Errors

A ServiceError when the hooks named no outbox schema, when no write transaction is active (the repository has no pool, so the service ran the write without one), or when the insert fails — which rolls the write back, since a write whose event cannot be staged must not commit.

Trait Implementations

impl Clone for WriteCtx

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WriteCtx

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

Formats the value using the given formatter.