Expand description
Minimal Rust SDK for the Durable Workflow worker protocol.
The crate covers the v1 Rust round-trip: start, signal, query, durably sleep,
and start and await child workflows; register a Rust worker; poll workflow,
activity, and read-only query tasks; reconstruct typed workflow-instance
state through deterministic replay; heartbeat worker and activity liveness;
and exchange JSON-native payloads through the same avro generic wrapper
used by the existing first-party SDKs.
Macros§
- json
- Construct a
serde_json::Valuefrom a JSON literal.
Structs§
- Activity
Call - Activity
Context - Activity
Failure - A stable, machine-readable terminal activity failure.
- Activity
Heartbeat Response - Activity
Options - Options recorded atomically on one deterministic
schedule_activitycommand. - Activity
Options Error - A machine-readable activity-options validation failure.
- Activity
Retry Policy - Durable server-side retry policy for one activity execution.
- Activity
Task - Child
Workflow Call - Future returned by
WorkflowContext::start_child_workflow. - Child
Workflow Failure - A stable, machine-readable child workflow failure delivered to its parent.
- Child
Workflow Options - Options recorded with a child-workflow command.
- Child
Workflow Result - A successful child result together with its durable parent-child identity.
- Child
Workflow Retry Policy - Durable retry policy for one child workflow invocation.
- Client
- Client
Builder - History
Event - Payload
Envelope - Poll
Workflow Task Response - Protocol
Failure - A stable failure returned when a server rejects an SDK protocol version.
- Query
Context - Immutable state supplied to a registered query handler.
- Query
Failure - A stable, machine-readable workflow query or query-task settlement failure.
- Query
Signal - One decoded signal in the committed workflow-history snapshot.
- Query
Task - An ephemeral server-routed query task.
- Register
Worker Response - Replay
Failure - A stable, machine-readable failure raised when workflow code no longer reconstructs the durable command stream recorded in history.
- Signal
Call - Timer
Call - Future returned by
WorkflowContext::sleep. - Worker
- Worker
Heartbeat Observation - Worker
Retry Policy - Bounded retry policy for worker poll acquisition and worker heartbeats.
- Workflow
Context - Workflow
Description - Workflow
Handle - Workflow
Identity - The identity of one durable workflow execution.
- Workflow
Instance - Typed local state owned by one deterministic workflow invocation.
- Workflow
Result Options - Workflow
Task
Enums§
- Activity
Backoff - Backoff intervals for one durable activity retry policy.
- Activity
Failure Kind - Stable terminal categories returned when an awaited activity does not succeed.
- Activity
Options Error Kind - Stable validation categories for
ActivityOptions. - Child
Workflow Failure Kind - Stable terminal categories returned when an awaited child does not succeed.
- Error
- Parent
Close Policy - Server behavior when a parent closes while its child is still open.
- Value
- Represents any valid JSON value.
Constants§
- CONTROL_
PLANE_ VERSION - DEFAULT_
CODEC - JSON_
CODEC - QUERY_
TASKS_ CAPABILITY - Worker-registration capability for server-routed read-only queries.
- QUERY_
TASK_ MINIMUM_ WORKER_ PROTOCOL_ VERSION - First additive worker protocol that defines query-task transport.
- SDK_
VERSION - WORKER_
PROTOCOL_ VERSION