Struct ActivityContext 

pub struct ActivityContext { /* private fields */ }

Handler-facing context for one activity execution.

Implementations

impl ActivityContext

pub fn new( workflow_id: WorkflowId, run_id: RunId, activity_id: ActivityId, attempt: u32, ) -> (Self, ActivityCancellationHandle)

Creates a context and the internal handle that can signal cancellation.

The full dispatch identity is required: an activity execution always belongs to one (workflow, run, activity, attempt), and a handler reads the workflow and run back to stamp the transcript events it emits.

pub fn with_transcript( workflow_id: WorkflowId, run_id: RunId, activity_id: ActivityId, attempt: u32, events: UnboundedSender<ActivityEvent>, ) -> (Self, ActivityCancellationHandle)

Creates a context whose transcript seam is live, for a host that owns the receiving end of events.

This is the seam Self::emit_event publishes on: every event a handler emits carries this context’s (workflow_id, run_id, activity_id, attempt) identity, which is exactly the key the server’s transcript sequencer files it under. A host that executes an activity IN PROCESS (the server’s declared-command path) uses this to hand its own publisher the same stream a remote worker’s drain would have delivered.

pub const fn activity_id(&self) -> &ActivityId

Returns this activity’s identifier.

pub const fn workflow_id(&self) -> &WorkflowId

Returns the workflow this activity belongs to.

pub const fn attempt(&self) -> u32

Returns this activity’s attempt number.

pub const fn run_id(&self) -> &RunId

Returns the concrete run this activity was dispatched by.

A handler that emits transcript events through Self::emit_event stamps this onto every ActivityEvent it builds: the transcript keyspace is keyed on (workflow, run, activity, attempt), and without the run two generations of one continue-as-new chain write to the same stream. Always present — the run is part of the dispatch identity, so the handler is never handed an absence it cannot resolve.

pub fn idempotency_key(&self) -> Option<&str>

Returns the stable external-effect key delivered with this task.

Live worker tasks always return Some; manually constructed unit-test contexts return None because they are not attached to a server task.

pub fn heartbeat(&self, detail: Option<Payload>) -> Result<(), WorkerError>

Emits a cooperative heartbeat request for this activity.

This is the PROGRESS channel: handlers call it to attach a progress payload to the activity’s liveness record. LIVENESS itself is owned by the worker runtime, which automatically heartbeats every in-flight activity within the server-assigned heartbeat window — a handler that never calls this still stays live for as long as it genuinely runs. Contexts created without a live heartbeat sender remain no-op contexts for isolated unit tests.

Errors

Returns WorkerError when an installed heartbeat seam has been closed.

pub fn emit_event(&self, event: ActivityEvent) -> Result<(), WorkerError>

Emit a neutral agent-observability ActivityEvent onto the transcript seam (NOI-5b).

Additive and OPTIONAL: on a context created without a live event seam (every isolated unit test, and every activity that does not run an instrumented agent) this is a no-op returning Ok(()), so behaviour is byte-identical to today. When a seam is installed the worker runtime drains these events and forwards them to the server’s transcript sequencer, which stamps the commit-allocated store_seq — the producer never assigns it.

Harness-neutral: the payload is a pure aion-core ActivityEvent; the per-harness mapping lives in the worker-side adapter, never here.

Errors

Returns WorkerError when an installed event seam has been closed (the runtime drain end was dropped) — a dropped transcript event is surfaced, never silently swallowed.

pub fn is_cancelled(&self) -> bool

Returns true once cooperative cancellation has been signalled.

pub async fn cancelled(&self)

Resolves when cooperative cancellation is signalled.

Trait Implementations

impl Clone for ActivityContext

fn clone(&self) -> ActivityContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ActivityContext

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

Formats the value using the given formatter.