vox-workflow-runtime API Reference (generated)

`vox-workflow-runtime`

Crate: vox-workflow-runtime · Version: 0.6.0 · Target: Library (lib.rs)

Interpreted workflow execution MVP (local + mens activity hooks)

Crate Overview

Minimal interpreted workflow runner: walks a [vox_compiler::hir::HirModule] workflow body for activity calls and executes no-op steps with optional mens hooks.

Activities whose name starts with mesh_ are treated as [PopuliActivity] steps when the mens feature is enabled: they register with [vox_populi::publish_local_registry_best_effort] and run on the iroh mesh (never a user-supplied URL in workflow source). Use with { mens: "noop" | "join" | "snapshot" | "heartbeat" | "dispatch" | "wait" } to select the operation; see mesh_noop, mesh_join, mesh_snapshot shorthands.
Other activities are recorded as local no-ops (journal only).

Codex journal: unless VOX_WORKFLOW_JOURNAL_CODEX_OFF=1 disables it (and provided DB config resolves), vox-cli persists the interpreted journal after a successful run via VoxDb::record_workflow_journal_entry (see docs/src/architecture/orchestration-unified-ssot.md). Journal rows include ActivityStarted / ActivityCompleted with activity_id for idempotency hints and carry journal_version = 1 in emitted event objects.

This crate is the MVP engine behind vox mens workflow run when vox-cli is built with workflow-runtime.

Features

Feature	Default / Enables
`default`	mens, sql
`mens`	dep:vox-populi, vox-populi/transport, dep:vox-mesh-transport, dep:iroh
`sql`	dep:vox-db
`test-support`	—

Workspace Dependencies

Dependency	Kind
`vox-compiler`	Normal
`vox-config`	Normal
`vox-db`	Normal
`vox-journal`	Normal
`vox-mesh-transport`	Normal
`vox-populi`	Normal
`vox-runtime`	Normal
`vox-compiler`	Development

Public API Surface

Modules

Module	Description
`db_tracker`	SQL-backed [`workflow::WorkflowTracker`] (requires the `sql` cargo feature).
`durable_promise`	`DurablePromise<T>` — the single awaitable primitive for distributed durable work (P1-T1).
`duration_literal`	Shared parser for `@scheduled` / `workflow_wait` duration literals (ADR-041 M-3, M-7).
`file_journal`	Append-only file-backed [`workflow::WorkflowTracker`] suitable for mobile + lightweight desktop.
`scheduled`	Persistent `@scheduled` runner (Phase 4.2; requires the `sql` cargo feature).
`workflow`	—