Module task 

Structs

AppendFrameOutcome

Outcome of append_frame().

ClaimedTask

A claimed execution with an active lease. The worker processes this task and must call one of complete(), fail(), or cancel() when done.

IdempotencyKey

Partition-scoped idempotency key for retry-safe EngineBackend::suspend.

ResumePolicy

Resume-side policy carried alongside ResumeCondition.

ResumeSignal

A signal that triggered a resume, readable by a worker after re-claim.

Signal

A signal to deliver to a suspended execution’s waitpoint.

StreamFrames

Result of read_stream / tail_stream — frames plus the terminal signal so polling consumers can exit cleanly.

SuspendArgs

Trait-surface input to [EngineBackend::suspend] (RFC-013 §2.2 + RFC-014 Pattern 3 widening).

SuspendOutcomeDetails

Shared “what happened on the waitpoint” payload carried in both SuspendOutcome variants.

SuspendedHandle

RFC-013 Stage 1d — cookie returned by the strict suspend wrapper.

Enums

CompositeBody

RFC-013 reserves this enum slot; RFC-014 populates it with the concrete composition vocabulary (AllOf + Count). The enum is #[non_exhaustive] so RFC-016 or later RFCs may add variants (AnyOf has been explicitly rejected per RFC-014 §2.3 in favour of Count { n: 1, .. }; the guard exists for orthogonal future work).

CountKind

How Count nodes distinguish satisfiers. RFC-014 §2.1 + §3.2.

FailOutcome

Outcome of a fail() call.

ResumeCondition

Declarative resume condition for SuspendArgs::resume_condition.

ResumeTarget

Where a satisfied suspension routes back to.

SignalMatcher

v1 signal-match predicate inside ResumeCondition::Single.

SignalOutcome

Outcome of deliver_signal().

StreamCursor

Opaque cursor for read_stream / tail_stream — re-export of ff_core::contracts::StreamCursor. Wire tokens: "start", "end", "<ms>", "<ms>-<seq>". Bare - / + are rejected — use StreamCursor::Start / StreamCursor::End instead. Opaque cursor for attempt-stream reads/tails.

SuspendOutcome

Trait-surface output from [EngineBackend::suspend] (RFC-013 §2.3).

SuspensionReasonCode

Reason category for a suspension (RFC-004 §Suspension Reason Categories).

SuspensionRequester

Who requested the suspension.

TimeoutBehavior

Timeout behavior at the suspension deadline (RFC-004 §Timeout Behavior).

TrySuspendOutcome

RFC-013 Stage 1d — outcome of the fallible try_suspend wrapper.

WaitpointBinding

How the waitpoint resource backing a SuspendArgs is obtained.

Constants

MAX_TAIL_BLOCK_MS

Maximum tail block duration accepted by tail_stream. Mirrors the REST endpoint ceiling so SDK callers can’t wedge a connection longer than the server would accept.

STREAM_READ_HARD_CAP

Maximum frames per read/tail call. Mirrors ff_core::contracts::STREAM_READ_HARD_CAP — re-exported here so SDK callers don’t need to import ff-core just to read the bound. Hard cap on the number of frames returned by a single read/tail call.

Functions

parse_report_usage_result

Parse the wire-format result of the ff_report_usage_and_check Lua function into a typed ReportUsageResult.

read_stream

Read frames from a completed or in-flight attempt’s stream.

tail_stream

Tail a live attempt’s stream.

tail_stream_with_visibility

Tail helper with an explicit RFC-015 TailVisibility filter.