Struct WorkflowHandle 

pub struct WorkflowHandle { /* private fields */ }

Live workflow process metadata cached in the active-execution registry.

The handle stores only the runtime process identifier value, not a runtime object or scheduler state. The cached status is reconciled from the durable event projection by the registry. Residency is engine-internal and separate from projected workflow status.

Implementations

impl WorkflowHandle

pub fn new(parts: WorkflowHandleParts) -> Self

Creates a workflow handle from process metadata and start-owned resources.

pub fn allocate_activity_ordinals(&self, count: u64) -> u64

Allocate count consecutive activity correlation ordinals.

The sequence is monotonic per run and shared by every NIF call the run makes (handles clone the same counter), so distinct workflow steps never collide on correlation keys. A re-spawned run (crash recovery, continue-as-new) gets a fresh handle and counter, and its replayed code re-allocates the same ordinals deterministically.

pub fn allocate_child_ordinals(&self, count: u64) -> u64

Allocate count consecutive child-workflow spawn ordinals.

Same determinism contract as Self::allocate_activity_ordinals: monotonic per run, shared by every NIF call the run makes, and re-allocated identically by replayed code on a re-spawned run. The n-th allocated ordinal correlates the n-th spawn_child call with the n-th recorded ChildWorkflowStarted in the run’s history segment, independent of event sequence numbers and of any asynchronous-arrival events interleaved between spawns.

pub fn allocate_timer_ordinals(&self, count: u64) -> u64

Allocate count consecutive timer ordinals.

Same determinism contract as Self::allocate_activity_ordinals: monotonic per run, shared by every NIF call the run makes, and re-allocated identically by replayed code on a re-spawned run. Used to derive anonymous timer identities (sleep, with_timeout scope deadlines) that stay stable across crash-recovery replay.

pub fn activity_ordinals_allocated(&self) -> u64

Activity ordinals allocated so far by this run’s execution.

Read-only progress probe: replay re-allocates deterministically, so a value below the run segment’s recorded ActivityScheduled count means the run is still mid-replay.

pub fn timer_ordinals_allocated(&self) -> u64

Timer ordinals allocated so far by this run’s execution.

Same replay-progress contract as Self::activity_ordinals_allocated, measured against recorded anonymous TimerStarted events.

pub fn child_ordinals_allocated(&self) -> u64

Child-workflow ordinals allocated so far by this run’s execution.

Same replay-progress contract as Self::activity_ordinals_allocated, measured against recorded ChildWorkflowStarted events.

pub fn signal_receives_consumed(&self, name: &str) -> u64

Number of receive_signal(name) calls this run has completed.

Drives the run-scoped consumption index for signal awaits: the k-th completed receive for a name consumes the k-th recorded SignalReceived for that name in this run’s segment. Replayed code re-executes the same receives in order and re-derives the same indices; a timed-out receive consumes nothing and does not advance.

pub fn mark_signal_receive_consumed(&self, name: &str)

Advance the completed-receive count for name by one.

pub fn signal_sends_completed(&self, name: &str) -> u64

Number of send_signal(name) calls this run has completed.

Drives the run-scoped correlation index for sends: the k-th completed send for a name correlates with the k-th recorded SignalSent for that name in this run’s segment. Replayed code re-executes the same sends in order and re-derives the same indices, independent of any same-name arrivals recorded around them.

pub fn mark_signal_send_completed(&self, name: &str)

Advance the completed-send count for name by one.

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

Returns the logical workflow identifier.

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

Returns the concrete run identifier.

pub const fn pid(&self) -> u64

Returns the embedded runtime process identifier value.

pub fn workflow_type(&self) -> &str

Returns the logical workflow type / entry module selected by the caller.

pub fn namespace(&self) -> &str

Returns the namespace that owns this workflow execution.

pub const fn loaded_version(&self) -> &ContentHash

Returns the loaded workflow package version identifier.

pub const fn cached_status(&self) -> WorkflowStatus

Returns the cached workflow status.

pub const fn residency(&self) -> Residency

Returns the live residency tracked separately from workflow status.

pub fn recorder(&self) -> Arc<Mutex<Recorder>>

Returns the shared single-writer recorder for later lifecycle transitions.

pub const fn completion(&self) -> &CompletionNotifier

Returns the completion notifier created at workflow start.

pub fn next_deterministic_nif_sequence(&self) -> u64

Returns and advances the workflow-local deterministic NIF call sequence.

Trait Implementations

impl Clone for WorkflowHandle

fn clone(&self) -> WorkflowHandle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WorkflowHandle

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

Formats the value using the given formatter.

impl Eq for WorkflowHandle

impl PartialEq for WorkflowHandle

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.